Skip to content

Commit 0727543

Browse files
committed
Update readme with new directory structure and node 6 requirement
1 parent 97a983d commit 0727543

File tree

1 file changed

+11
-35
lines changed

1 file changed

+11
-35
lines changed

README.md

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# react-redux-starter
22

3-
A universal starter kit built with react, react-router and redux. Server
4-
rendering with react and express, bundles with Webpack with hot module reloading
5-
and hot style reloading with SCSS support.
3+
A universal starter kit built with ES2015, react, react-router and redux. Server
4+
rendering with react and express. Bundled with Webpack with hot module and css
5+
reloading with SCSS support.
66

77
## Prerequisites
88

9-
* Node 4.2+ is recommended.
9+
* Node.js 6+ is **required**, as the Webpack configuration files uses ES2015
10+
extensively.
1011

1112
* Webpack
1213
```
@@ -50,29 +51,17 @@ Direct your browser to `http://localhost:3000`.
5051
│   │   ├── shame
5152
│   │   ├── utils
5253
│   │   └── vendors
54+
│   ├── components # "Dumb" components directory
5355
│   ├── config # Contains the redux store configuration. Add anything else you like.
56+
│   ├── containers # "Smart" containers directory
57+
│   ├── layouts # Layout files
5458
│   ├── middleware # Custom redux middleware can be placed here.
5559
│   ├── reducers # Redux reducers
5660
| | └── index.js # Root reducer. Imports all other reducers.
5761
│   ├── routes # Routes each have an index.js which exports a react-router Route.
58-
│   │   ├── app
59-
│   │   │   ├── components
60-
│   │   │   ├── containers
61-
│   │   │   └── index.js
62-
│   │   ├── example # The name of route.
63-
│   │   │   ├── components # "Dumb" components
64-
│   │   │   └── containers # "Smart" containers
65-
│   │   │   └── index.js # Exports a react-router route. Uses [alternate configuration](https://github.com/rackt/react-router/blob/master/docs/guides/basics/RouteConfiguration.md#alternate-configuration)
66-
│   │   └── home
67-
│   │   └── containers
68-
│   │   │   └── index.js
69-
│   ├── selectors # Memoized selectors. See https://github.com/rackt/reselect
70-
│   ├── shared # Shared actions and components and do not belong to a single route.
71-
│   │   ├── actions
72-
│   │   └── components
73-
│   ├── layouts # Layout files
74-
│   └── util # Utility methods
75-
│   └── config
62+
│   │   ├── example.js # Individual routing file
63+
│   │   └── index.js # Root route
64+
│   └── selectors # Memoized selectors. See https://github.com/rackt/reselect
7665
├── server # Server-side code.
7766
└── webpack # Webpack configuration files.
7867
```
@@ -126,16 +115,3 @@ heroku config:set ASSET_HOST=/dist/
126115
# OR
127116
heroku config:set ASSET_HOST=https://s3.amazonaws.com/mybucket/myasssets/
128117
```
129-
130-
## Additional Notes
131-
132-
If you're debugging in a mobile browser and you want to access your project
133-
locally, do the following:
134-
135-
- Make sure your mobile device on the same network as your desktop/laptop.
136-
- Run `npm start` with a `HOSTNAME` environment variable set to your computer's
137-
local ip address (the computer that your dev environment is on):
138-
```
139-
HOSTNAME=10.0.1.3 npm start
140-
```
141-
- Browse to `http://10.0.1.3:3000` on your mobile device.

0 commit comments

Comments
 (0)