Skip to content

Latest commit

 

History

History
executable file
·
105 lines (69 loc) · 3.78 KB

README.md

File metadata and controls

executable file
·
105 lines (69 loc) · 3.78 KB
Raw

START TO GULP

HTML5 starter kit for creating HTML5 applications (both web and mobile) and client facing user interfaces (UIs), intergrated with Gulpjs for fast, clean and optimized code base.

UPDATE: Added support for ES6 using Babelify

It has all the necessary requirements to get anyone started in creating apps fast and easy using gulp.

Prefer GRUNT? I've got you covered here.

What does it do for me?

START-TO-GULP basically does the following:

  1. compiles your scripts, templates, styles (both transpilation and precompilation is taken care of here)
  2. lints them (checks for any syntax error)
  3. notifies you about errors via console and system notifications
  4. wraps the scripts and templates in common.js / AMD modules. (for build systems)
  5. concatenates scripts and styles
  6. generates source maps for concatenated files
  7. copies assets and static files the respective required project production directory
  8. shrinks the output by minifying code and optimizing images
  9. monitors/watches your files for changes and updates realtime wherever relevant, reloads to reflects the changes to the browser
  10. create a test and distribution/final versions of your app or UI without compromising the original code

Concatinates all CSS into app.full.css and JS into app.full.js or app.full.min.js after minification. Generating sourcemaps for each CSS and JS build.

Dependencies

You will need to install some stuff, if you haven't already:

Majors:

Secondaries(click for further information):

  • npm (installed together with node.js, usually bundled in it)
  • gulpjs (part of the instructions below)
  • bower

Getting Started

Once you have NodeJS installed, run_(type or copy & paste; your poison)_:

To download the boilerplate

$ git clone https://github.com/kn9ts/start-to-gulp name_of_your_awesome_project

After cloning/copying the boilerplate, please get into your project's directory/folder

$ cd name_of_your_awesome_project

To install Gulp-CLI (Command Line) plugin/tool

$ sudo npm install -g gulp

To install all the projects dependecies

$ npm install

To install default project front-end assets/libraries eg. bootstrap, jQuery...

NOTE: This downloads CSS and JavaScript libraries that default in most projects nowadays. They are downloaded into the public/vendor folder that can be referenced in the HTML you are editing as you would have with any CSS and JavaScript files in your project, only that this way we give your application a good structure and files separation.

$ bower install

Note: Each of the '$' (dollar) sign denotes a step (so 4 steps in total)

Note: You can skip STEP 2($ sudo npm install -g gulp) if you already did install the gulp command line plugin/tool in any prior project with or without any relation to this boilerplate

This will install all the things you need for running the gulp-tasks automatically.

Note: As stated prior. You need to have a running node.js and ruby along with npm. Please install this before setting up START in your project's directory. Ruby comes default in most systems nowadays so I believe you do have that already.

Finally Build and launch

Now you can start developing your site. Therefore use the Gulp default task (type in your Terminal and press ENTER):

$ gulp

This will create a public folder, if does not already exist. With the compiled and optimised application's css and js files.

Release History

Version: 1.2.0

License

Copyright (c) 2014 Eugene Mutai Licensed under the MIT license