Skip to content

Commit 0fd1142

Browse files
committed
Update README.md file
1 parent 1fe90fc commit 0fd1142

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
The point of this app is to experiment with learning react and setting up a good
44
base application repo that can be easily forked for new projects down the road.
55

6+
## Dependencies & Initial Setup
7+
8+
```bash
9+
$ npm install -g gulp
10+
```
11+
12+
```bash
13+
$ npm install
14+
```
15+
616
## Build Process
717

818
```bash
@@ -15,6 +25,15 @@ transformation process. This includes:
1525

1626
* clean
1727
* browserify
18-
* babel transofmration (for ES6)
28+
* babel transformation (for ES6)
1929
* bundling to `app.js`
2030
* watchers
31+
32+
33+
### Client
34+
35+
The `client` dir is the main folder referenced in the `gulpfile.js`. As such all
36+
of the client files should reside there. The other directories `client-` are different
37+
versions of the app in various stages of its life. For example `client-basic` is just that,
38+
an extremely basic React app. `client-flux` is after Flux was introduced. The main
39+
`client` folder is where the final ES6 version of the app resides.

0 commit comments

Comments
 (0)