Skip to content
This repository was archived by the owner on Apr 11, 2019. It is now read-only.

Commit 03a3fdd

Browse files
authored
Docs: update readme.md with description of new generators
1 parent 6bc002b commit 03a3fdd

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ If this is confusing, don't fret, we've set you up with a few examples and code
2323

2424
## Example Apps
2525
Below are a few example apps that have been built with this project
26+
- Udacity Alumni App
27+
- [See the Code](https://github.com/udacityalumni/alumni-client)
28+
- Live App coming soon
29+
- RyanCollins.io v3.0
30+
- [See the Code](https://github.com/RyanCCollins/ryancollinsio)
31+
- Live App coming soon
2632
- React Weekly
2733
- [See the Code](https://github.com/RyanCCollins/react-weekly)
2834
- [See the Live App](http://www.reactweekly.co/)
@@ -35,9 +41,6 @@ Below are a few example apps that have been built with this project
3541
- Meetup Event Planner
3642
- [See the Code](https://github.com/RyanCCollins/meetup-event-planner)
3743
- [See the Live App](http://meetup-event-planner.herokuapp.com/)
38-
- Udacity Alumni App
39-
- [See the Code](https://github.com/udacityalumni/alumni-client)
40-
- Live App coming soon
4144

4245
## Experimental Features
4346
### Server Rendering
@@ -188,9 +191,11 @@ The boilerplate contains generators for easy project scaffolding. At the moment
188191
- SCSS modules
189192
- Tests for all of the above
190193
- README.md file that documents the component
194+
- GraphQL: If you want, the generator can add collocated queries and mutations using GraphQL / ApolloClient. Accept the option to use this feature.
191195
- Page `npm run generate:page`
192196
- Name: The name of the route, i.e. Home, which gets converted to `HomePage`
193197
- Route: the route that corresponds to the page
198+
- Container Import: Most of the time, a Route exists only to import a container by the same name. This is enabled by default, so make sure to run the container generator if you want to use this feature.
194199

195200
To run the generators with a list of options, run
196201
```
@@ -210,17 +215,13 @@ where <type_of_component> is one of: component, container or page.
210215
The generators use the same feature-first file organization as the rest of the project, encapsulating components within their own folder.
211216

212217
### **Gotchas**
213-
In order to get the import / export to work, the generator does some pattern matching of the comments in the files to place the new imports. Just don't delete the comments within the root level index.js file in each directory and things will work fine!
218+
In order to get the import / export to work, the generator does some pattern matching of the comments in the files to place the new imports. Just don't delete the any comment that is prefixed with GENERATOR and things will work great.
214219

215220
From `app/src/container/index.js` or `app/src/component/index.js`
216221
```
217-
// ... Other components here
218-
import MyComponent from 'MyComponent';
219-
220-
export {
221-
// ... Other components here
222-
MyComponent
223-
}
222+
/* GENERATOR: Assemble all containers for export */
223+
export LandingContainer from './LandingContainer';
224+
export AppContainer from './AppContainer';
224225
```
225226

226227
### Configuring your own generators

0 commit comments

Comments
 (0)