Skip to content

Latest commit

 

History

History
94 lines (71 loc) · 2.29 KB

README.md

File metadata and controls

94 lines (71 loc) · 2.29 KB

#FAST BOILERPLATE

A simple boilerplate to create projects with Jade, Stylus, Gulp, Browserify and Karma.

Maybe you want to read about them:

For grid system I use Jeet with some help from Kouto Swiss for animations, reset and a lot of great mixins. And for responsive utilities, Rupture is awesome =)

Getting Started

Installation

First of all, install the dependencies to run this boilerplate.

# Clone this repository
$ git clone git://github.com/willianjusten/Fast.git new_project
$ cd new_project

# install dependencies
$ npm install

With the commands above, you have everything to start.

Folders and Files

new_project -
	/build -
		/css
			main.css
		/img
		/js
			main.js
		.htaccess
	/src -
		/img
		/js
		/styl
		/templates
		.editorconfig
		gulpfile.js
		package.json
	/tests -
		/unit

Examples

If you want to see how this works, see this branch.

Or clone the repository and change to the branch tests

# Clone this repository
$ git clone git://github.com/willianjusten/Fast.git new_project
$ cd new_project

# change the branch
$ git checkout tests

# install dependengcies
$ npm install

Tasks

  • gulp: Initialize watch for changes and a server(localhost:8080)
  • gulp fy: Initialize watch for changes and a server(localhost:8080) using browserify mode
  • gulp js: execute js files
  • gulp browserify: execute js files in browserify mode
  • gulp jade: compile jade files
  • gulp stylus: compile stylus files
  • gulp imagemin:compress image files
  • gulp connect: inicialize a server
  • gulp watch: call for watch files
  • gulp watchfy: call for watch files (browserify mode)
  • gulp -p: minify all files for production
  • gulp fy -p: minify all files for production (browserify mode)
  • gulp build -p: minify files and deploy via rsync
  • gulp buildfy -p: minify files and deploy via rsync (browserify mode)
  • karma start: launch a phantonjs and watch for tests