priyeshdiukar/app-starter-kit

App Starter Kit is a boilerplate for web development. Tools for building a great experience across many devices and performance oriented.

Welcome to App Starter Kit!

app-starter-kit is an opinionated boilerplate for web development based on ECMAScript 5th Edition. It helps you kickstart new project with ease , prescribing best practices and tools to help you stay productive.

• Tools
• Dependencies
• Installation
• Upcoming Features

Tools

App Starter Kit comprises of two tools for improving productivity and satisfaction when building a web app: the build tool (Gulp) and the package manager (npm)

Dependencies

• gulp-autoprefixer
• gulp-concat
• gulp-cssnano
• gulp-eslint
• gulp-notify
• gulp-sass
• gulp-scss-lint
• gulp-uglify

gulp-autoprefixer

gulp-autoprefixer is a CSS post processor. It combs through compiled CSS files to add or remove vendor prefixes like -webkit and -moz after checking the code against caniuse.com.

gulp-concat

gulp-concat concatenates files by your operating systems newLine. It will take the base directory from the first file that passes through it.

gulp-cssnano

gulp-cssnano is a modular minifier, built on top of the PostCSS ecosystem.

gulp-eslint

gulp-eslint is a gulp plugin for processing files with ESLint.

gulp-notify

gulp-notify is a gulp plugin to send messages based on Vinyl Files or Errors to Mac OS X, Linux or Windows using the node-notifier module. Fallbacks to Growl or simply logging.

gulp-sass

gulp-sass is a gulp plugin for SASS.

gulp-scss-lint

gulp-scss-lint is a linter use to validate .scss files. This plugin requires Ruby and scss-lint. scss-lint is a tool to help keep your SCSS files clean and readable by running it against a collection of configurable linter rules. You can run it manually from the command line, or integrate it into your SCM hooks.

gulp-uglify

gulp-uglify minifies file with UglifyJS2

Installation

For gulp-scss-lint to work requires following dependencies on your system.

sudo apt-get install ruby
sudo gem install scss_lint

Then proceed with the following:

git clone https://github.com/priyeshdiukar/app-starter-kit.git
cd app-starter-kit
npm install
npm run start-dev

Upcoming features

• custom scss lint config.
• git pre-commit and post-commit hooks.
• unit testing framework integration.
• app-starter-kit2 (A complete rewrite, based on babel and webpack to support ECMAScript 6 development.)