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

Commit 3029b23

Browse files
authored
Chore: update readme.md with explanation of architecture
1 parent e681246 commit 3029b23

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,12 @@ Following the lead of the famous [React Boilerplate]() project, this starter pro
88

99
We incorporate an ESLint configuration and follow strictly the [AirBnb JS & JSX style guides](https://github.com/airbnb/javascript).
1010

11-
# Experimentation
12-
This is a living and breathing project. At times, we may implement features that are expiremental, meaning that they may not entirely work. We will do our best to point out the areas that are not fully tested and encourage you to submit issues and pull requests if you find a bug and want to help us fix it!
11+
# What is Feature First?
12+
In most projects and frameworks, files are organized in a File type first fashion. For example, your tests exist in a test folder, your styles in a styles folder. This boilerplate takes a different approach.
13+
14+
We encourage encapsulation of features by asking that you organize each feature into a seperate folder (feature-first). In React, this means that your containers and components exist in their own folders, along with literally every other file that pertains to that one component. Your actions, reducers, tests, styles, and everything else are all internal to the component they represent. By decoupling your features from the rest of your app, you set yourself up to reuse your UI components in future projects. You can thank us later!
15+
16+
This may be confusing at first, but we've set you up with a few examples and code generation tools. Give it a try! We promise you will enjoy it.
1317

1418
### Docker Support
1519
Coming soon the app will support Docker, which will contain a configured web server to make deployment of this boilerplate simple! You can take a look at [this branch](https://github.com/RyanCCollins/scalable-react-boilerplate/tree/feat_rc_docker_config) for more details.

0 commit comments

Comments
 (0)