It does provide a nice development environment with live reloading JavaScript and CSS, testing with zuul and linting with eslint.
The main dependencies are:
- budo for watching and serving the app for development
- Browserify for bundling the JavaScript
- node-sass for Scss
- chokidar-cli for watching Sass files
- tape and zuul for testing
- Eslint with the Cycle.js plugin for linting
- rimraf for cleaning the project
Just run.
npm install
Then you can run:
npm start
to start developing. This will provide a auto-reloading dev-server as well as css hotreloading. Because of browserify and babel, development in es-2015 style and importing modules like in node is provided.
For more specific npm commands read the npm script documentation.
These are all the npm scripts tasks that come with this boilerplate.
The npm commands in bold letters are the ones you might use the most.
npm Command | Description |
---|---|
npm start |
Build everything, start all watch tasks and serve the index.html file. |
npm test |
Run browser tests in zuul. |
npm run lint |
Lint your files Cycle.js-style. |
npm run clean |
Deletes the build folder. |
npm run budo |
Starts a development server, compiles and watches JavaScript and watches other assets. |
npm run build:js:prod |
Builds JavaScript for production with browserify and Uglify, generates external source maps. |
npm run build:css |
Compiles the Sass files to CSS. |
npm run build:css:prod |
Compiles the Sass files to CSS for production. |
npm run watch:scss |
Build and watch the Sass files with node-sass and chokidar. |
MIT © [Kolja Kutschera, Christian Auer]