gabrieldrs / ideal-website-starting-project

Ideal Website Starting Project

This project is intended to be a simple, easy to use, barebones website. No back-end is implemented so it can be used with many different back-end languages. This project only includes:

• jQuery
• Bootstrap
• Some cool little npm scripts (described in some details below)
• Dev Dependencies in order to make everything work

In order to run this you need npm installed, start by typing:

$ npm install

With all modules ready, you will have the following useful scripts:

build-js

Uses browserify in order to make the file content/js/main.js browser-ready and outputs the result in public/js/script.js.

build-sass

Compiles the file content/sass/main.scss using node-sass and add browser prefixes using autoprefixer. The output goes to public/css/style.css.

build-min-js

The same as build-js but also minifies the resulting js using uglifyjs.

build-min-sass

The same as build-sass but also minifies the resulting css using clean-css.

build

Uses concurrently to run both build-js and build-sass.

build-min

Uses concurrently to run both build-min-js and build-min-sass.

watch-js

Uses nodemon to watch the js folder for changes and call build-js according.

watch-sass

Uses nodemon to watch the sass folder for changes and call build-sass according.

watch

Uses concurrently to run both watch-js and watch-sass at the same time.

To run any of these scripts just type:

$ npm run <command-name>