Skip to content
Dan ford edited this page Jan 8, 2016 · 13 revisions

Welcome to the lodestar-ractive-gulp-boilerplate wiki!


About the boilerplate

This boilerplate provides you with a quick set up for lodestar-ractive. So far, it mainly provides you with:

  • Precompiling views
  • Converting ES6 to ES5 using Babel
  • Bundling / 'rolling up' of modules using Rollup
  • Giving you a test server, at localhost:8080, to see what your your compiled app looks like with live-reload enabled

Note: Only edit files in the app folder as anything changed in the dist folder will be destroyed on recompilation.

Boilerplate usage

  • npm run start will run the boilerplate in 'dev mode', this will compile your app, start a server with live reload at localhost:8080 and watch for changes.
  • npm run build will do the same as the default gulp task, except the files will not be watched and minified js files will also be available.
  • npm run server will run gulp-connect which provides you with a live-reload instance of your dist on localhost:8080, npm run start will do this automatically.

Project Structure

  • JS Entry: app/main.js
  • Controllers : app/controllers/
  • HTML Entry: app/index.html
  • Views: app/views/
  • Views will get compiled to a the file templates.js which provides your app with the variable Templates.

CSS

We haven't added anything todo with CSS e.g. less or stylus as there are to many preprocessor to make everybody happy. Instead, in the future we may be making a Yeoman generator for lodestar-ractive to make setup even easier.

Documentation

Sorry about the lack of documentation but there will be more updates soon!

TODO

  • Add Test framework e.g. Testem or Karma
Clone this wiki locally