Universal JS Boilerplate

---

WARNING This version of Universal JS Boilerplate uses Babel v6, which is UNDER ACTIVE DEVELOPMENT. The plugin system currently has a lot of issues, and the Babel v6 presets for ES2015/ES7 features are having a few difficulties as of Nov 6th, 2015. Noted among the currently non-working features are static and non-static class properties, decorators, and the destructuring of complex objects in function arguments.

This is a scaffolding project that includes boilerplate code for:

• Node
• Heroku configuration
• Babel, Babel runtime, ES6/2015, ES7/2016
• Express, with a default server, some example code and routes, static file sharing, and proxy code
• Node-sass, some example SCSS, grids, normalize and typeplate css kits (installed from bower)
• Example files/resources
• An example .gitignore for the project
• A host of npm scripts for watching and building your files
• Documentation and testing scaffolds

How to get started

1. Start your own project folder with a git clone, and if you plan to push this clone to GitHub, you'll need to change your origin:

   cd ~/Github\ Projects/
   git clone git@github.com:matthiasak/universal-js-boilerplate.git NEWPROJECT
   cd NEWPROJECT
   git remote remove origin
   git remote add origin YOUR_SSH_ADDRESS

2. Install prerequisites

   npm install

3. Start your server:

   npm start
   
   # Alternatively, if you need nodemon to auto-reload your server
   # (when doing server-side work)
   # npm run nodemon

4. Ready to push your code to heroku?

   git commit -am "Let's do this"
   heroku create <my app name>
   git push heroku HEAD:master

5. Or are you pushing to gh-pages instead?

   npm run publish:gh-pages

6. Or are you using surge.sh?

   npm run publish:surge
   # you may be prompted to login or signup,
   # and then you'll be asked what URL to push to on surge.sh

   Note: you can teardown a surge.sh URL with npm run teardown, which will prompt you for the URL to bring down

7. Want to generate your own documentation with esdocs?

   # build docs and open locally
   npm run docs
   open dist/esdoc/index.html
   # or build AND publish to gh-pages or to surge
   npm run docs:gh-pages
   npm run docs:surge

License

MIT.