README.md

Web Workflow Boilerplate

A simple boilerplate for web project.

Table of Contents

• Installation
• Usage
• Contents
  • Webpack configuration
  • Babel configuration
  • Eslint configuration
• Support
• Contributing
• Authors

Installation

git clone https://github.com/JonGiamp/web-workflow-boilerplate.git
cd web-workflow-boilerplate
rm -rf .git
yarn install

Think to update package.json with your personal informations

Usage

To launch the production build :

yarn prod

The build fails if eslint or flowtype encounters an error.

To launch the development environment :

yarn dev

Launch webpack-dev-server with hot reload and webpack-dashboard

To manual run eslint :

yarn lint

To automatic fix eslint error :

yarn lintfix

To manual run flowtype :s

yarn flow

Contents

This boilerplate uses:

• webpack
• babel
• eslint
• flow

Webpack configuration

Name	Type	Target	Environment
babel-loader	loader	JS	all
flowtype-loader	loader	JS	all
eslint-loader	loader	JS	all
uglifyjs-webpack-plugin	plugins	JS	prod
ExtractTextPlugin	plugins	CSS	all
style-loader	loader	CSS	dev
css-loader	loader	CSS	prod
postcss-cssnext	loader	CSS	prod
url-loader	loader	IMG	all
img-loader	loader	IMG	prod
file-loader	loader	FONTS	all
cheap-module-eval-source-map	devtool	X	dev
source-map	devtool	X	prod
webpack-dev-server	server	X	dev
webpack-dashboard	tools	X	dev

Babel configuration

• syntax-dynamic-import
• transform-object-rest-spread
• transform-flow-comments

Eslint configuration

• airbnb guidelines
• comma-dangle: ["error", "always-multiline"]

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

Authors

• Jonathan Giamporcaro - Initial work - Github / Twitter

See also the list of contributors who participated in this project.