Clean code & doc enhancement & url router issue fix

Author: shinxi

README-zh.md

@@ -2,23 +2,24 @@
 
 
 JavaScript library boilerplate, a web project template using:  
-> JavaScript Library - [React](https://facebook.github.io/react/);  
-> UI Library - [React Bootstrap](https://react-bootstrap.github.io/);  
+> JavaScript Library - [React](https://facebook.github.io/react/);   
+> Application Architecture - [Redux](http://redux.js.org/);  
+> Declarative routing for React - [React Router](https://github.com/ReactTraining/react-router);  
+> React Components that Implement Google's Material Design.  - [Material UI](https://github.com/callemall/material-ui);  
+> Mock Server based on Express - [Mock Server](https://shinxi.github.io/react/#/6/1);  
 > Future ECMASCript Standards - [ES6+](http://babeljs.io/docs/learn-es2015/);  
 > Javascript Compiler - [Babel](http://babeljs.io/);  
-> Application Architecture - [Redux](http://redux.js.org/);  
 > Module Bundler - [webpack](http://webpack.github.io/docs/tutorials/getting-started/);  
-> Javascript Test Runner - [Karma](https://karma-runner.github.io/0.13/index.html);  
-> Test Framework - [Mocha](http://mochajs.org/);  
-> Tests Assertion - [Chai](http://chaijs.com/);  
-> Test spies/stubs/mocks - [Sinon](http://sinonjs.org/).  
 
 ### Features
 
 ### Getting Started
 
   * Follow the [getting started guide](./getting-started.md) to download and run the project
 
+### Build & Deploy
+  * Follow [Build Doc](./build.md) to build and deploy your project.
+
 ### Directory Layout
 
 ```
@@ -45,7 +46,6 @@ JavaScript library boilerplate, a web project template using:
 
   * [Getting Started with React.js](http://facebook.github.io/react/)
   * [Redux Intro](http://redux.js.org/)
-  * [Getting Started with React Bootstarp](https://react-bootstrap.github.io/getting-started.html)
   * [Getting Started with Webpack](https://webpack.github.io/docs/tutorials/getting-started/)
   * [Learn ES6](https://babeljs.io/docs/learn-es6/)
   * [ES6 Features](https://github.com/lukehoban/es6features#readme)

README.md

@@ -0,0 +1,12 @@
+## Build
+
+Let's say your project name is Foo. 
+
+* cd to Foo.
+* `npm run prod`
+The command will generate all static files into build folder.
+* `npm run start:prod`
+You can test the build by run `npm run start:prod`, the command will bring up a node server which servers all static files under build foler. 
+Visit [http://localhost:5000](http://localhost:5000). If it works well, you'll see the page runs up.
+* Deploy. 
+Put the files under build folder into your web server.

build.md

@@ -1,12 +1,12 @@
 {
-  "name": "react-boilerplate",
+  "name": "react-material-ui-boilerplate",
   "version": "1.0.0-alpha",
-  "description": "React BoilerPlate with material-ui",
+  "description": "BoilerPlate For React + Material UI + React Router + Redux",
   "scripts": {
     "start": "webpack-dev-server --port 3000",
     "server": "nodemon server/index.js -w server/",
     "prod": "webpack -p --config webpack.config.prod.js --progress --colors",
-    "start:prod": "node scripts/startProduct.js"
+    "start:prod": "node server/index.js"
   },
   "babel": {
     "presets": [
@@ -33,9 +33,9 @@
     "babel-preset-es2015": "^6.3.13",
     "babel-preset-react": "^6.3.13",
     "babel-runtime": "^6.18.0",
+    "body-parser": "^1.15.2",
     "chai": "^3.5.0",
     "cookie-parser": "^1.4.3",
-    "body-parser": "^1.15.2",
     "copy-webpack-plugin": "^4.0.1",
     "css-loader": "^0.26.1",
     "express": "^4.13.3",

getting-started-zh.md

@@ -20,7 +20,7 @@ app.use('/', express.static(path.join(__dirname, '../build')));
 
 
 app.get("*", function(req, res) {
-  res.sendFile(__dirname + '/../build/index.html')
+  res.sendFile(path.join(__dirname, '/../build/index.html'));
 })
 
 var server = app.listen(app.get('port'), function() {