generator-fountain-backbone
v1.0.0-rc1
Published
Yeoman Fountain generator to scaffold a webapp with Backbone.js written in ES6 (Babel) through Webpack including tools Gulp 4, ESLint, Browsersync and Karma
Downloads
2
Readme
Fountain Backbone.js Generator
This Yeoman generator allows you to start an Backbone.js web app with the best Developer Experience out of the box!
No matter what framework or module management you want to use, we got you covered with a cutting edge working configuration.
We use Gulp 4 as a task manager but we'll ask you questions about:
- Modules management: Webpack
- JS preprocessor: Babel
- CSS preprocessor: Sass, Stylus, Less, none
This generator is a sub-generator of the the Yeoman Fountain generator for webapps generator-fountain-webapp.
Generator Fountain Backbone structure
To take profit of the best of the Yeoman infrastructure, we heavily relies on the composability natures of the generators.
Thereby, each needs of your future application will be addressed by a dedicated Yeoman generator (each will be used depending of the options you selected or not).
More informations in DESIGN.md.
Web tooling layer
Module management layer
Usage
Requirement Node 4+ && NPM 3+
This generator is targeted to be used with Node >= 4.0.0 and NPM => 3.0.0. You can check your version number with the command
node --version && npm --version
Install
Install required tools yo
:
npm install -g yo
Install generator-fountain-backbone
:
npm install -g generator-fountain-backbone
Run
Create a new directory, and go into:
mkdir my-new-project && cd my-new-project
Run yo fountain-backbone
, and select desired technologies:
yo fountain-backbone
Use NPM scripts
npm run build
to build an optimized version of your application in /distnpm run serve
to launch a browser sync server on your source filesnpm run serve:dist
to launch a server on your optimized applicationnpm run test
to launch your unit tests with Karmanpm run test:auto
to launch your unit tests with Karma in watch mode
Or Gulp tasks
If you have gulp-cli
installed in global packages you can use equivalent:
gulp
orgulp build
gulp serve
gulp serve:dist
gulp test
gulp test:auto
If you don't have gulp-cli
installed in global, you should have this error:
/usr/local/lib/node_modules/gulp/bin/gulp.js:121 gulpInst.start.apply(gulpInst, toRun); TypeError: Cannot read property 'apply' of undefined
Sub-generators
Few sub-generators are available. You can see the full list by running yo --generators
.
Each generator has 2 options:
- You can set the name of the generated item with
--name
- You can set the path of the generated item with
--dir
Example:
yo fountain-backbone:component --name myComponent --dir components/game