Skip to content

Commit 306ec81

Browse files
committed
update README
1 parent 560e88e commit 306ec81

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,14 @@ This starter also embeds `JWT token based` `authentication` (check [Route](https
99
- *webpack is as simple as possible*
1010
- *ReactJS is written with `optimization tricks` (stateless, pure render...).*
1111
- *`pure front-end` = server independant (use whatever you want as server: NodeJS, Rails, .NET...)*
12+
- contains both [SPA](https://github.com/MacKentoch/react-redux-graphql-apollo-bootstrap-webpack-starter/tree/master/src/server/SPA) and [SSR](https://github.com/MacKentoch/react-redux-graphql-apollo-bootstrap-webpack-starter/tree/master/src/server/SSR/src) server implementation
13+
- caching implementation with `workbox-webpack-plugin` (*so that it follows PWA path!*)
1214
- *`redux` + `devTools` + `hot reload`= how did I developed without them before?*
1315
- *graphQL makes API to be " `has been` "*
1416
- *no more struggle in redux with async thank to Apollo Client (you can even get rid of redux thunk or redux saga if you needed theses just for your asyncs. Otherwise keep them since they are nice :smile:)*
1517
- [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension#redux-devtools-extension) to make developments a pure pleasure.
1618

17-
18-
## Detailed Content
19+
##Detailed Content
1920

2021
**Front:**
2122

@@ -25,6 +26,7 @@ This starter also embeds `JWT token based` `authentication` (check [Route](https
2526
- React-Redux 5.x (*Redux is not specific to ReactJS, you could easily use it with Angular2 for instance*)
2627
- React-Router-Redux (*previously named react-simple-router*)
2728
- react-router (4.x- [github :link:](https://github.com/reactjs/react-router))
29+
- styled-components (3.2.x- [github :link:](https://github.com/styled-components/styled-components))
2830
- Bootstrap (3.x - [github :link:](https://github.com/twbs/bootstrap))
2931
- React-Bootstrap ([github :link:](https://github.com/react-bootstrap/react-bootstrap))
3032
- font-awesome ([github :link:](https://github.com/FortAwesome/Font-Awesome))
@@ -53,17 +55,16 @@ This starter also embeds `JWT token based` `authentication` (check [Route](https
5355

5456
- jest
5557

58+
##Usage
5659

57-
## Usage
58-
59-
### Prerequisite
60+
###Prerequisite
6061

61-
#### Node JS version required is `>=6.x`.
62+
####Node JS version required is `>=6.x`.
6263
*Build with node js v8.x but should be ok with node js 6.x.*
6364

6465
> Better use [nvm](https://github.com/creationix/nvm) to manage your Node JS versions.
6566
66-
### server
67+
###server
6768

6869
An Easy and fast way to get your graphql backend is to **register for free at [Scaphold](https://scaphold.io)**.
6970

@@ -87,7 +88,7 @@ An Easy and fast way to get your graphql backend is to **register for free at [S
8788

8889
![graphiQL_overview.png](https://raw.githubusercontent.com/MacKentoch/react-redux-graphql-apollo-bootstrap-webpack-starter/master/print_screens/graphiQL_overview.png)
8990

90-
### Configure starter application:
91+
###Configure starter application:
9192

9293
In Scaphold click on `My API` and `copy your application link`.
9394

@@ -104,13 +105,13 @@ export const appConfig = {
104105

105106
> from now you got all needed to run this starter
106107
107-
### Install dependencies
108+
###Install dependencies
108109

109110
```bash
110111
npm install
111112
```
112113

113-
### run dev : hot reload mode (*+ redux-devtools-extension*)
114+
###run dev : hot reload mode (*+ redux-devtools-extension*)
114115

115116

116117
```bash
@@ -119,36 +120,36 @@ npm run start
119120

120121
NOTE: be sure you already installed [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension#redux-devtools-extension) in your browser to get the best development experience.
121122

122-
### bundle dev mode (*+ redux-devtools*)
123+
###bundle dev mode (*+ redux-devtools*)
123124

124125
```bash
125126
npm run dev
126127
```
127128

128-
### tests
129+
###tests
129130

130131
```bash
131132
npm run test
132133
```
133134

134-
### bundle production mode
135+
###bundle production mode
135136

136137
```bash
137138
npm run prod
138139
```
139140

140-
### run dev bundle
141+
###run dev bundle
141142
```bash
142143
npm run start-spa-dev
143144
```
144145

145-
### run prod bundle
146+
###run prod bundle
146147
```bash
147148
npm run start-spa-prod
148149
```
149150

150151

151-
## License
152+
##License
152153

153154
The MIT License (MIT)
154155

0 commit comments

Comments
 (0)