Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 2.68 KB

README.md

File metadata and controls

100 lines (67 loc) · 2.68 KB

webapp

This project is based on generator-vars-webapp. Visit for more details. With jquery, bootstrap/bootsrapSASS and modernizr on board

Usage

Install node modules if they are not already installed:

$ npm install

Install bower components if they are not already installed:

$ bower install

Test dev environment:

$ gulp --debug

Visit localhost:9000 in browser; by default you should see 'Hello, World!'.

Test prod environment:

$ gulp

Visit localhost:9000 in browser; by default you should see 'Hello, World!'.

Tasks

gulp --debug --watch --serve: Compiles all assets/templates, serves the site and watches for file changes. Best used during development.

gulp sprites : Create a png/jpeg sprite, for use, please, uncomment module in settings.scss

gulp svgsprites : Create a svg sprite from svg icon in images/icon folder uncomment module in settings.scss

gulp svgiconfont : Create a svg icons font from svg icon in images/icon folder uncomment module in settings.scss

gulp bower : Add a plugin companents in index.html (use bower install <package name> --save )

gulp build: Builds the entire project in production.(please, use gulp clean before builds prodaction version) use just gulp.

gulp imgresize: Create different sizes of image with prefix tr_, for correctly install please visit https://www.npmjs.com/package/gulp-image-resize, look more on base/setting.css BACKGROUND IMAGES RESPONSIVE MIX-IN

All tasks are broken into micro-tasks, check out the tasks folder for more details. Also see tasks/.taskconfig for more custom flags such as --skip-js-min, --skip-css-min, etc.

Cloud Setup (Linux)

Updating APT Packages

$ sudo apt-get update

Installing git

$ sudo apt-get install git-core

Installing nvm Globally

Install nvm (see https://github.com/xtuple/nvm):

$ sudo wget -qO- https://raw.githubusercontent.com/xtuple/nvm/master/install.sh | sudo bash

Install preferred node version:

$ nvm install x.xx.x

Serving with Nginx

Install Nginx:

$ sudo apt-get install nginx

Edit Nginx default config file and point the root to the project path:

$ sudo nano /etc/nginx/sites-available/default

Reload Nginx

$ sudo service nginx reload

Visit external IP of your VM instance. Voila.

Common Issues

  1. If gulp-watch is giving Bus error: 10, try updating node (v0.12.0 seems to be ok).

License

This software is released under the MIT License.