es6-jspm-gulp-boilerplate

ES6 + JSPM + Gulp Boilerplate

A boilerplate for developing ES6+ apps using JSPM & Gulp.

JSPM

JSPM is an all-in-one command line tool for package management, module loading and transpilation. Read more about it here and here.

Boilerplate Features

• Uses JSPM instead of Bower to manage packages
• Transpiles ES6+ automagically using Babel via JSPM
• Uses SystemJS to load modules via JSPM
• SASS compilation using LibSass and Autoprefixer
• Local dev server with LiveReload using Gulp Connect
• Testing using Karma with Mocha + Chai (bonus: write your tests in ES6)
• Linting with ESLint and SCSS-Lint
• Generates documentation automatically using ESDoc and SassDoc
• Unlicensed

Usage

1. Clone this repo from https://github.com/alexweber/es6-jspm-gulp-boilerplate.git or install via npm: npm install es6-jspm-gulp-boilerplate
2. Run npm install in the root directory (will automatically run jspm install)
3. Run gulp or npm start to start the local dev server (you may need to install Gulp locally using npm install -g gulp)
4. Write an awesome app! ☺

Testing

Run karma start or npm test to run tests once.

Run npm run test:watch to run tests continuously.

Generating documentation

Run npm run docs to generate documentation for your JavaScript and SASS automatically in the docs folder.

Building

Run gulp build or npm run build to build the app for distribution in the dist folder.

Updating

In the event of issues running npm install after updating to the latest version of the boilerplate, I recommend you rm -rf node_modules, re-run npm install and go grab some coffee while it runs :)

Contributing

If you like this/find it useful/find a bug please open an issue and, better yet, submit a Pull Request! ☺ Any and all help appreciated, thanks!

---

No rights reserved. Made with ♥ by Alex Weber