migration

Author: MacKentoch

README.md

@@ -1,43 +1,45 @@
-React 16.8+ React-Router 4 + Redux + Bootstrap + Webpack 4 with Hot Reload and redux-devtools-extension STARTER
-==========
+# React 16.8+ React-Router 4 + Redux + Bootstrap + Webpack 4 with Hot Reload and redux-devtools-extension STARTER
+
 [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/MacKentoch/react-redux-bootstrap-webpack-starter)
 [![Build Status](https://travis-ci.org/MacKentoch/react-redux-bootstrap-webpack-starter.svg?branch=master)](https://travis-ci.org/MacKentoch/react-redux-bootstrap-webpack-starter)
 [![Coverage Status](https://coveralls.io/repos/github/MacKentoch/react-redux-bootstrap-webpack-starter/badge.svg?branch=master)](https://coveralls.io/github/MacKentoch/react-redux-bootstrap-webpack-starter?branch=master)
 
 > My best React + redux project starter.
 
-- *webpack is as simple as possible*
-- *ReactJS is written with `optimization tricks` (stateless, pure render, PureComponent...).*
-- *`pure front-end` = server independant (use whatever you want as server: NodeJS, Rails, .NET...)*
+- _webpack is as simple as possible_
+- _ReactJS is written with `optimization tricks` (stateless, pure render, PureComponent...)._
+- _`pure front-end` = server independant (use whatever you want as server: NodeJS, Rails, .NET...)_
 - `SPA` but `SEO` and/or `PWA` friendly since use of `dynamic imports` and `application snapshot`.
 
-*Concept behind:* same as [react-bootstrap-webpack-starter](https://github.com/MacKentoch/react-bootstrap-webpack-starter) **but added `Redux` and amazing and helpful [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension#redux-devtools-extension).**
+_Concept behind:_ same as [react-bootstrap-webpack-starter](https://github.com/MacKentoch/react-bootstrap-webpack-starter) **but added `Redux` and amazing and helpful [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension#redux-devtools-extension).**
 
 ![preview](./preview/preview.png)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FMacKentoch%2Freact-redux-bootstrap-webpack-starter.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FMacKentoch%2Freact-redux-bootstrap-webpack-starter?ref=badge_shield)
 
 ## Detailed Content
 
 **Front:**
+
+- Typescript
 - React JS (16.8+ - [github :link:](https://github.com/facebook/react))
-- Redux (*as you application grows managing state will be a serious concern, save pain with Redux*)
-- React-Redux (*Redux is not specific to ReactJS, you could easily use it with Angular2 for instance*)
+- Redux (_as you application grows managing state will be a serious concern, save pain with Redux_)
+- React-Redux (_Redux is not specific to ReactJS, you could easily use it with Angular2 for instance_)
 - redux-devtools-extension ([github :link:](https://github.com/zalmoxisus/redux-devtools-extension#redux-devtools-extension))
 - connected-react-router 4 ([github :link:](https://github.com/supasate/connected-react-router))
 - react-router (4.x- [github :link:](https://github.com/reactjs/react-router))
 - Bootstrap (4.x - [github :link:](https://github.com/twbs/bootstrap))
 - reactstrap ([github :link:](https://github.com/reactstrap/reactstrap))
-- loadable-components - work with reactsnap for better static website performance - (*stuck to pre v2.2.3+ breakings changes, waiting for a new solution see [PR](https://github.com/stereobooster/react-snap/pull/338/commits/adf107b4bff212a854a93e2d90f89d369433a807)*)
+- loadable-components - work with reactsnap for better static website performance - (_stuck to pre v2.2.3+ breakings changes, waiting for a new solution see [PR](https://github.com/stereobooster/react-snap/pull/338/commits/adf107b4bff212a854a93e2d90f89d369433a807)_)
 - font-awesome ([github :link:](https://github.com/FortAwesome/Font-Awesome))
 - animate.css ([github :link:](https://github.com/daneden/animate.css))
 - classnames ([github :link:](https://github.com/JedWatson/classnames))
 - react-motion ([github :link:](https://github.com/chenglou/react-motion))
 - Webpack 4.x ([github :link:](https://github.com/webpack/webpack))
-- babel 7+ ([github :link:](https://github.com/babel/babel))
-- axios ([github :link:](https://github.com/mzabriskie/axios) *Why: simple, complete, isomorphic ...*)
+- axios ([github :link:](https://github.com/mzabriskie/axios) _Why: simple, complete, isomorphic ..._)
 
 **Tool chain:**
-- babel 7+
+
+- Typescript
 - eslint
 - webpack 4
 - hot reload
@@ -49,6 +51,7 @@ React 16.8+ React-Router 4 + Redux + Bootstrap + Webpack 4 with Hot Reload and r
   - svg and fonts formats
 
 **tests:**
+
 - Jest
 - enzyme
 
@@ -61,44 +64,49 @@ React 16.8+ React-Router 4 + Redux + Bootstrap + Webpack 4 with Hot Reload and r
 ### Install
 
 ```bash
-yarn install
+# from root directory:
+cd front && yarn install
 ```
-### bundle dev mode (*+ redux-devtools*)
+
+### bundle dev mode (_+ redux-devtools_)
 
 ```bash
-yarn run dev
+# from root directory:
+cd front && yarn run dev
 ```
 
-### dev : hot reload mode (*+ redux-devtools*)
+### dev : hot reload mode (_+ redux-devtools_)
 
 ```bash
-yarn run start
+# from root directory:
+cd front && yarn run start
 ```
 
 ### tests
 
 ```bash
-yarn run test
+# from root directory:
+cd front && yarn run test
 ```
 
 ### bundle production mode
 
 ```bash
-yarn run prod
+# from root directory:
+cd front && yarn run prod
 ```
 
-### mini node-express server (for dev or prod bundles)
+### mini node-express server
 
-with server hot reload:
+⚠️Ensure having bundled the application before (result is in `_ROOT_DIR_/docs` directory), then:
 
 ```bash
-yarn run serve-dev
-```
-
-without hot reload:
+# from root directory:
 
-```bash
-yarn run serve-prod
+# install dependencies the first time only:
+cd server && yarn install
+# run the server:
+yarn run run-server # this will serve ROOT/docs content!
 ```
 
 ## Donate
@@ -120,5 +128,4 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FMacKentoch%2Freact-redux-bootstrap-webpack-starter.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FMacKentoch%2Freact-redux-bootstrap-webpack-starter?ref=badge_large)