Skip to content

Commit 40614fc

Browse files
committed
updating docs
1 parent 5625537 commit 40614fc

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,27 @@ Each of our events is defined in its own json file in the `events/` directory. A
1717
4. Submit a [PR](https://help.github.com/articles/using-pull-requests/) back to this repo.
1818

1919
Please feel free to ask any questions or add additional info via the [PR comments](https://help.github.com/articles/commenting-on-the-diff-of-a-pull-request/).
20+
21+
## Contributing
22+
23+
### Install/Build
24+
`npm install && gulp`
25+
26+
Some of the dependencies compile C++ so the first install might take a few mins depending on your machine.
27+
28+
### Project Layout
29+
30+
```
31+
├── events/ <-- meetup event json files
32+
├── src/
33+
│   ├── App.ls <-- React App
34+
│   ├── components/ <-- React components
35+
│   ├── entry.ls <-- Webpack entry
36+
│   ├── images/ <-- image assets
37+
│   ├── index.html
38+
│   └── sass/ <-- styles
39+
├── gulpfile.js
40+
├── package.json
41+
├── README.md
42+
└── webpack.config.js
43+
```

0 commit comments

Comments
 (0)