a boilerplate for React-Babel-Webpack project
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 1 commit ahead, 52 commits behind ruanyf:master.

README.md

This repo is a boilerplate for React-Babel-Webpack project. You could use it as a base to build your own web app.

Additional features

This repo is fork from ruanyf/react-babel-webpack-boilerplate with following additional features:

  • Move static files to public directory
  • Test framework by using Mocha/Enzyme/chai/sinon
  • Script to deploy app to github pages (You need install python and python package named ghp-import)

Features

  • Equip with React, ES6 & Babel 6
  • Lint with ESlint and Airbnb's style sheet.
  • Build with Webpack
  • Support hot module replacement
  • Auto Open a new browser tab when Webpack loads, and reload the page when you modified the code
  • Use Commitizen to produce commit message according to AngularJS convention
  • Support git hook pre-commit used to lint and test your code
  • Support git hook commit-msg used to lint your commit message
  • Use conventional-changelog to generate CHANGELOG.md

How to use

First, you should clone the repo and install the dependencies.

$ git clone git@github.com:ruanyf/react-babel-webpack-boilerplate.git <yourAppName>
$ cd <yourAppName>
$ npm install

Then, launch the boilerplate app.

$ npm start

You should see a new browser tap opening and a title of "Hello World" in http://127.0.0.1:8080.

From there, you start to develop your own code in the app directory. When you finish coding, use npm run build or npm run deploy to build the static files.

When committing your code, you should use AngularJS's commit message convention. Otherwise, the repo will throw an error. If you use npm run commit instead of git commit, the command will help you to produce a formatted commit message.

License

MIT