Giter VIP home page Giter VIP logo

feb's Introduction

FEB(Front-End-Boilerplate)

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.

Included Tools

It includes

Build System

  • Gulp - Front-end task runner and build system.

Testing

  • Mocha - TDD/BDD test framework.
  • Sinon - Spy and data mocking.
  • Chai - Assertions library.

Preprocessor

Modular Development

Basic Usage

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.

How it works

After running the gulp command, things will happen:

  1. Copy HTML: HTML files directly placed in src will be copied into bin.
  2. Compile CoffeeSctipt : CoffeeScript files directly placed in src/scripts will be compiled to JS files which will be placed in bin/scripts. But note that files placed in subfolders of src/scripts won't be compiled but they can and should be required by 'entry' CoffeeScript placed directly in src/scripts through Browserify.
  3. Compile Less: Less files placed in src/stylsheets will be compiled to CSS files which will be placed in bin/stylesheets. Just like CoffeeScrtipt, only 'naked' Less files will be compiled.
  4. Copy libraries and static resources: Copy lib/, assets/ folder and all their contents into bin/.
  5. Testing: Specs in test/specs will be run and results will be shown in terminal.
  6. 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 in bin/, changes will trigger automatic refresh of browser if you have the LiveReload plugin installed in your Chrome/Firefox.

Distribution

Use

$ gulp build

to bulid and minify all stuff. A dist folder will be created and ready for distribution.

Examples

TODO

License

Released under the MIT license.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.