Skip to content

Commit

Permalink
docs(readme): refactor workspaces section
Browse files Browse the repository at this point in the history
  • Loading branch information
oxcened authored Dec 3, 2023
1 parent 5a5ae13 commit bf45484
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ In this project, the tool used to achieve this is [yarn workspaces](https://clas
Yarn workspaces does many things:
- It links npm packages contained in the workspaces. This enables us to have a great DX, as we can run all the packages
- It links npm packages contained in the monorepo. This enables us to have a great DX, as we can run all the packages
in development mode at the same time and see how they behave together as we code.
- It provides CLI commands that are very useful to manage monorepos. For instance, the `yarn build` script of this
project runs `yarn workspaces foreach -pt run build`, which builds all the packages in the monorepo based on the
Expand All @@ -139,15 +139,15 @@ The monorepo contains the following types of packages:
- The `core` package - contains the code that makes up the phone and binds all the "app" packages together.
Apps are plugged-in inside [phoneApps.ts](/packages/core/src/app/features/PhoneApp/phoneApps.ts).
- The `app` packages - each package is an "app" that takes place into the phone app gallery.
- The `utils` package - contains common utils used to code the "apps".
- The `utils` package - contains common utils helpful to code the "apps".
## Scalability
This project is powered by React Router v6. All the packages have access to the router and each "app" package is able to have
its own routes.
Each and every "app" is lazy loaded. This is incredibly important because it means that, no matter how many apps get plugged-in,
loading times remain constant.
loading time remains constant.
## Yarn PnP
Expand Down

0 comments on commit bf45484

Please sign in to comment.