generator-fountain-webapp
v1.0.0
Published
Yeoman Fountain generator to scaffold a webapp with React or Angular written in ES6 (Babel), TypeScript through Webpack or SystemJS including tools Gulp 4, ESLint, Browsersync and Karma
Downloads
66
Readme
Fountain Webapp Generator
This Yeoman generator allows you to start any Webapp 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:
- Framework: React, Angular 2, Angular 1, Vue 2
- Modules management: Webpack, SystemJS, none
- JS preprocessor: Babel, TypeScript, none
- CSS preprocessor: Sass, Stylus, Less, none
This generator is the entry point of the Yeoman Fountain generators for webapps. It can be considered as the v2 of generator-gulp-angular.
Generator Fountain Webapp 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 framework layer
This generators can be used directly to bypass the framework question.
Web tooling layer
Module management layer
Usage
Requirement Node 6+ && NPM 3+
This generator is targeted to be used with Node >= 6.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-webapp
:
npm install -g generator-fountain-webapp
Run
Create a new directory, and go into:
mkdir my-new-project && cd my-new-project
Run yo fountain-webapp
, and select desired technologies:
yo fountain-webapp
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
If you want to access sub-generators, you have to globally install one of the following generators:
- generator-fountain-react
- generator-fountain-angular2
- generator-fountain-angular1
- generator-fountain-vue
Start development
Backers
Support us with a monthly donation and help us continue our activities.
Sponsors
Become a sponsor and get your logo on our website fountainjs.io and on our README on Github with a link to your site.