]> git.wincent.com - hextrapolate.git/blob - README.md
Update broken test
[hextrapolate.git] / README.md
1 react-hot-boilerplate
2 =====================
3
4 The minimal dev environment to enable live-editing React components.
5
6 ### Usage
7
8 ```
9 npm install
10 npm start
11 open http://localhost:3000
12 ```
13
14 Now edit `src/App.js`.  
15 Your changes will appear without reloading the browser like in [this video](http://vimeo.com/100010922).
16
17 ### Linting
18
19 This boilerplate project includes React-friendly ESLint configuration.
20
21 ```
22 npm run lint
23 ```
24
25 ### Using `0.0.0.0` as Host
26
27 You may want to change the host in `server.js` and `webpack.config.js` from `localhost` to `0.0.0.0` to allow access from same WiFi network. This is not enabled by default because it is reported to cause problems on Windows. This may also be useful if you're using a VM.
28
29 ### Missing Features
30
31 This boilerplate is purposefully simple to show the minimal configuration for React Hot Loader. For a real project, you'll want to add a separate config for production with hot reloading disabled and minification enabled. You'll also want to add a router, styles and maybe combine dev server with an existing server. This is out of scope of this boilerplate, but you may want to look into [other starter kits](https://github.com/gaearon/react-hot-loader/blob/master/docs/README.md#starter-kits).
32
33 ### Dependencies
34
35 * React
36 * Webpack
37 * [webpack-dev-server](https://github.com/webpack/webpack-dev-server)
38 * [babel-loader](https://github.com/babel/babel-loader)
39 * [react-hot-loader](https://github.com/gaearon/react-hot-loader)
40
41 ### Resources
42
43 * [Demo video](http://vimeo.com/100010922)
44 * [react-hot-loader on Github](https://github.com/gaearon/react-hot-loader)
45 * [Integrating JSX live reload into your workflow](http://gaearon.github.io/react-hot-loader/getstarted/)
46 * [Troubleshooting guide](https://github.com/gaearon/react-hot-loader/blob/master/docs/Troubleshooting.md)
47 * Ping dan_abramov on Twitter or #reactjs IRC