From 7f1e984fbdd3d3835d024d70616314093ddc72be Mon Sep 17 00:00:00 2001 From: Josh Pigford Date: Wed, 10 Jan 2024 12:44:18 -0600 Subject: [PATCH] Update README.md Signed-off-by: Josh Pigford --- README.md | 49 ++----------------------------------------------- 1 file changed, 2 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 68ccc5b3184..20b10ce2b04 100644 --- a/README.md +++ b/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 - -![folder-structure-diagram](https://github.com/maybe-finance/maybe/assets/35243/fbe702b0-a6a7-41b1-a677-80ff7fe7f656) +## Relevant reading... +* [Learn about how the app is organized as a monorepo](https://github.com/maybe-finance/maybe/wiki/Monorepo-File-Structure-Overview) ----