Code Monkey home page Code Monkey logo

ar-boilerplate's Introduction

Boilerplate using modern frontend tool to accelerate the dev ( gulp / coffee / stylus / jade / webpack / livereload ). It allow you to test the whole stuff or each module separetly base on async loading of optimized bundle.

To resume it make files light, loading fast & test easy :)

If you are looking for a very simple template have a look at Template.

Getting started

  • Install nodejs if you don't have it : http://nodejs.org/
  • copy or clone the template somewhere
  • Then open the terminal and push the following commands :
cd yourfolder // move to yourfolder
rm -rf .git && git init //remove the previous git files and create a new
npm install //if you have an erorr try with sudo
gulp //start the main app ( see below )

Task(Gulp)

Test the Main app or a module ( compile / server livereload / watch for change ) :

gulp
gulp --module 001

Compile the file only :

gulp compile //compile the main app
gulp compile --module 001 //compile the module 001

Build the final optimized files ( compile/imagemin/cssmin/jsmin/versionning/etc.. ) :

gulp dist

Features

  • compile your stylus / jade / coffeescript automatically
  • create sourcemap for coffeescript & stylus
  • create a local server with livereload ( reload your browser when you change a file )
  • create bundle to load the module asynchronously
  • create page html to test each module individually
  • notification via growl
  • optimized .httaccess / manifest / robot for your webapp
  • optimize your final file

Architecture

Files architectures

  • src : source files coffee/stylus/jade
  • build : builded files from source
  • build/index.html : page for testing the main app
  • build/module_001.html : page for testing the module '001'
  • dist : final files compressed & optimized
  • static : static files not builded ( .htaccess, image, etc..)
  • static/vendors/ : your lib for the project
  • gulp : command gulp

FAQ

  • How to stop the server? crtl+c in the terminal
  • How to change the image compression? edit gulp/optimize.js
  • How to change the port of the server? edit gulp/browser-sync.js
  • Why no bower/napa? They are great but on big lib(three/pixi) they install too much stuffs. Also not push the lib can be bad if you want to edit them ( like the depth-sorter in threejs ).

This template use

#####tools

#####librairies js

##Versions 1.0:

  • first implementation

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.