k4rli/fauxjira
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README's

Browse Source
This commit is contained in:
ireic
2020-01-12 01:59:08 +01:00
parent dc5c8b835e
commit c1a740cf65
3 changed files with 42 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
client/README.md
View File

@@ -1,4 +1,4 @@
# Project structure
# Project structure 🏗
I've used this architecture on multiple larger projects in the past and it performed really well.
@@ -6,6 +6,8 @@ There are two special root folders in `src`: `App` and `shared` (described below
The main rule to follow: **Files from one module can only import from ancestor folders within the same module or from `src/shared`.** This makes the codebase easier to understand, and if you're fiddling with code in one module, you will never introduce a bug in another module.
<br>
| File or folder | Description |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `src/index.jsx` | The entry file. This is where we import babel polyfills and render the App into the root DOM node. |