Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
86 lines (55 loc) · 1.05 KB

DEVELOPMENT.md

File metadata and controls

86 lines (55 loc) · 1.05 KB

Development

Requirements

  • node.js 10.0+
  • npm 10.0+

NOTE: we recommend using nvm

brew install nvm

Tasks

The following outlines the commands for common development tasks.

Setup

To setup the project for development run the below commands. After these have been run you will be able to use the project else where, run tests, etc.

git clone https://github.com/brianneisler/firemin.git
cd firemin
nvm install
nvm use
npm run setup

Build

To build the project

npm run build

Watch

To build on every file change

npm run watch

Clean

To clean and remove all built files

npm run clean

Cleanse

To clean AND wipe out all installed modules as well as package-lock.json files, use the cleanse script.

To cleanse the project

npm run cleanse

Test

Run tests for the project

npm test

Lint

Run lint for the project

npm run lint

Docs gen

Run docs generation for the project

npm run docs:gen
⚡