lrenhrda / no-framework-webpack-boilerplate

A boilerplate containing essential build tools usable with any framework.

no-framework-webpack-boilerplate

Based on NotSpecial/webpack-babel-eslint.

A boilerplate containing essential build tools. It uses Webpack and includes the Webpack Dev Server with hot-reloading for easy development and Babel, UglifyJS and a optimized production config for Webpack to build transpiled, minified .js files along with gzipped files.

Furthermore ESLint, preconfigured to use the Standard Style, is provided to check your code. (Feel free to adjust .eslintrc to you needs)

Finally, a Dockerfile is included that uses a two-stage build to create a final image that only contains the built files and the small http-server, which can server the files (and the gzipped versions) and nothing else, ready to deploy in any cluster.

Contrary to other boilerplates, only build tools are included, and you are free to choose whatever framework you like and get started quickly!

Setup

Clone this repository and run npm install to install all dependencies.

(Node and npm are required.)

Commands

A few useful commands are configured in npm:

# Start the development server
npm start

# If the development server does not detect file changes, try starting as root
sudo npm start

# Lint your code
npm run lint

# Lint and fix errors if possible
npm run lint-fix

# Build your project
npm run build

Configuration

In many situations, development and production environments require different configurations. With Webpack Resolve, this can be handled easily. There are two configuration files, config.js and config.prod.js, which you can adjust to your needs.

In your code, require('config') or import * as config from 'config', which will automatically resolve to config.js when using the development server and to config.prod.js when building your project.

Acknowledgments

Many thanks go to Moritz Schneider, who created the initial configuration for webpack.