Skip to content

A boilerplate to get started with ES6 + Babeljs + Webpack 2

License

Notifications You must be signed in to change notification settings

dantaeyoung/es6-webpack2-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ES6 + Babel + Webpack 2 starter

I have build this boilerplate following the Webpack 2 documentation which is great.

Why another boilerplate?

The answer is simple. I wanted to go through the whole process of setting up my environment to build awesome web apps and be able to understand every single piece of a boilerplate config. That's why I decided to build my own. I'm very thankful to the new Webpack 2 documentation which has helped me a lot.

This starter kit comes with:

  • Yarn: A fast dependency manager
  • Webpack 2 setup for production and development environments
  • Live reload with webpack-dev-server
  • Babeljs to compile next generation JavaScript
  • HTML Webpack Plugin: Especially useful for webpack bundles that include a hash in the filename which changes every compilation. With this plugin you write a HTML template and the plugin takes care of inserting the .js and .css script for you whenever your code changes and gets compiled.
  • css-loader and style-loader to loader your css and put into your .js bundle when in dev mode or load the css and put it in a separate folder when in production mode with extract-text-webpack-plugin
  • url-loader used to load your images into your bundle. This plugin can return a Data Url if the file is smaller than a byte limit. That means if you have an image file which is less than a size lime you have specified on your webpack config that assets gets bundled inline, otherwise it is copied to to your dist folder with file-loader. Hence, when you add url-loader to your devDependencies you also have to add file-loader cuz it's a peer dependencie.

Getting Started

To get started, clone the repo and run yarn install, or npm install if you are using npm. I recommend Yarn because it's fast than npm and also enables you to have a cache on your machine so you don't waste your bandwidth having to download everything whenever your run npm install.

Get the latest snapshot, or the entire repo if you remove --depth=1

git clone --depth=1 [email protected]:oPauloChaves/es6-webpack2-starter.git project-name
cd project-name
yarn install
# or
npm install

You have to have Node (version >= 6) installed on your machine. This project depends on webpack-dev-server which recommends you use version 6 for the moment because there are some known issues with version 7. In my machine I have been using node v7 with no issues.

Running in development mode

yarn start
# or
npm start # I haven't tested it with npm though

The app is available on localhost:3000

Building for production

yarn run build

Running the production build

yarn run preview

The app is available on localhost:3000

Testing

Sorry, no tests yet. Use it at your own risk.

Linting

Sorry again, no linting yet.

Contributing

Pull requests are very welcome!

TOD0

About

A boilerplate to get started with ES6 + Babeljs + Webpack 2

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published