Cycle.js Browserify Boilerplate

While this boilerplate is heavily inspired by cycle-webpack-boilerplate it is currently a simpler setup. So far it is not implementing hot module reloading.

It does provide a nice development environment with live reloading JavaScript and CSS, testing with zuul and linting with eslint.

The main dependencies for this boilerplate 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
• XO with some light customization for linting
• rimraf for cleaning the project

Usage

First clone this repo and install the dependencies.

git clone https://github.com/kahlil/cycle-browserify-boilerplate.git && npm install

Then change the project name, repository link and description in your package.json and change the remote URL for your Git repo.

git remote set-url origin master [YOUR GIT URL HERE]

Or just download the ZIP and initialize a fresh Git repo with git init.

Then npm install.

npm scripts 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.
npm run lint:fix	Lint your files and try to automatically fix errors.
npm run clean	Deletes the build folder.
npm run budo	Starts a development server, compiles and watches JavaScript and watches other assets.
npm run browserify	Builds the JavaScript app, creates source maps.
npm run uglify	Minifies the JavaScript app, creates source maps.
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.

License

MIT © Kahlil Lechelt