mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-08-09 07:25:19 +02:00
Update README.md
Signed-off-by: Josh Pigford <josh@joshpigford.com>
This commit is contained in:
parent
c264f281d1
commit
7f1e984fbd
1 changed files with 2 additions and 47 deletions
49
README.md
49
README.md
|
@ -10,54 +10,9 @@ The README below was what we used internally, so many of the links won't work an
|
|||
|
||||
There's a LOT of work to do to get this functioning, but it should be feasible.
|
||||
|
||||
## Monorepo File Structure Overview
|
||||
|
||||
This repository uses the monorepo management tools from NRWL called `nx`. The NX dev tools come with pre-configured TS, ESLint, Prettier, Jest, Cypress and more, and provide an extensive suite of commands to lint, test, serve, and build applications. [Here's a great 10 minute video](https://nx.dev/l/r/getting-started/intro#10-minute-nx-overview) that walks through what nx can do.
|
||||
|
||||
### Structure
|
||||
|
||||
**Notes**
|
||||
|
||||
Through ESLint, the following rules apply:
|
||||
|
||||
- libs/shared can be imported to any app OR lib
|
||||
- libs/server can be imported to server and workers apps
|
||||
- libs/client can be imported to client app
|
||||
- libs/client/shared can be imported to any libs/client/features
|
||||
- libs/server/shared can be imported to any libs/server/features
|
||||
|
||||
```
|
||||
apps/
|
||||
client/
|
||||
server/
|
||||
workers/
|
||||
libs/
|
||||
design-system/
|
||||
client/
|
||||
src/
|
||||
features/
|
||||
{feature1-name}/
|
||||
{feature2-name}/
|
||||
shared/
|
||||
server/
|
||||
src/
|
||||
features/
|
||||
{feature1-name}/
|
||||
{feature2-name}/
|
||||
shared/
|
||||
shared/
|
||||
src/
|
||||
features/
|
||||
{feature1-name}/
|
||||
{feature2-name}/
|
||||
utils/
|
||||
types/
|
||||
```
|
||||
|
||||
### Decision Tree
|
||||
|
||||

|
||||
## Relevant reading...
|
||||
|
||||
* [Learn about how the app is organized as a monorepo](https://github.com/maybe-finance/maybe/wiki/Monorepo-File-Structure-Overview)
|
||||
|
||||
----
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue