Simple front-end development workflow. You can use it for a fast and smooth kick-off of a front-end project or configurate it to your own workflow farther.
New version FEB uses Gulp for build system. And old version FEB which leverages on Grunt can be found here.
It includes
Build System
- Gulp - Front-end task runner and build system.
Testing
Preprocessor
- CoffeeScript - JavaScript preprocessor.
- Less - CSS preprocessor.
Modular Development
- Browserify - A super powerful module system.
NOTE: It assumes that Node.js and NPM have been installed in your system.
Install global dependencies,
$ npm install -g browserify gulp
Clone project and install development dependencies,
$ git clone https://github.com/livoras/feb.git
$ cd feb
$ npm install
Then just fly,
$ gulp
and open your browser to load http://localhost:8080/bin/index.html
and change source codes of src
.
After running the gulp
command, things will happen:
- Copy HTML: HTML files directly placed in
src
will be copied intobin
. - Compile CoffeeSctipt : CoffeeScript files directly placed in
src/scripts
will be compiled to JS files which will be placed inbin/scripts
. But note that files placed in subfolders ofsrc/scripts
won't be compiled but they can and should be required by 'entry' CoffeeScript placed directly insrc/scripts
through Browserify. - Compile Less: Less files placed in
src/stylsheets
will be compiled to CSS files which will be placed inbin/stylesheets
. Just like CoffeeScrtipt, only 'naked' Less files will be compiled. - Copy libraries and static resources: Copy
lib/
,assets/
folder and all their contents intobin/
. - Testing: Specs in
test/specs
will be run and results will be shown in terminal. - Watch changes and livereload: Files's changes in
src
will make gulp rerun tasks above. And if you start a local server and open your broswer to load pages inbin/
, changes will trigger automatic refresh of browser if you have theLiveReload
plugin installed in your Chrome/Firefox.
Use
$ gulp build
to bulid and minify all stuff. A dist
folder will be created and ready for distribution.
TODO
Released under the MIT license.