Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/d-koppenhagen/vue-vite-monorepo-playground

A Nx Monorepo Playground for setting up Micro Frontends, Shared Libs and a Backend for Frontend primarily using Vite
https://github.com/d-koppenhagen/vue-vite-monorepo-playground

Last synced: 3 days ago
JSON representation

A Nx Monorepo Playground for setting up Micro Frontends, Shared Libs and a Backend for Frontend primarily using Vite

Awesome Lists containing this project

README 

        



# VueViteMonorepoPlayground



This project was generated using [Nx](https://nx.dev).






🔎 **Smart, Fast and Extensible Build System**



## Goal



The goal is to provide a Nx monorepo with the following contents/capabilities:



- A frontend that will work as an app shell for multiple microfrontends

  - it should be possible to interact with those microfrontends (routing, events, etc.)

- two separate microfrontends

  - it should be possible to start them individually and there should no need to run inside the app shell

- A shared library that provides components for the app shell as well as for the microfrontends

  - The provided components can be launched inside a storybook

- A small backend for frontend that can be connected with the app shell / microfrontends

- A shared library that can be consumed either by the backend or the frontends

  - It should provide shared helper functions, models, etc.



![app composition overview](./assets/app-composition.drawio.svg)



### Additional Requirements



- All apps and libs must be written in TypeScript.

- The frontend Apps and libs should be bundled by Vite.

- All apps and libs can work / be deployed standalone



## Adding capabilities to your workspace



Nx supports many plugins which add capabilities for developing different types of applications and different tools.



These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.



Below are our core plugins:



- [React](https://reactjs.org)

  - `npm install --save-dev @nrwl/react`

- Web (no framework frontends)

  - `npm install --save-dev @nrwl/web`

- [Angular](https://angular.io)

  - `npm install --save-dev @nrwl/angular`

- [Nest](https://nestjs.com)

  - `npm install --save-dev @nrwl/nest`

- [Express](https://expressjs.com)

  - `npm install --save-dev @nrwl/express`

- [Node](https://nodejs.org)

  - `npm install --save-dev @nrwl/node`



There are also many [community plugins](https://nx.dev/community) you could add.



## Generate an application



Run `nx g @nrwl/react:app my-app` to generate an application.



> You can use any of the plugins above to generate applications as well.



When using Nx, you can create multiple applications and libraries in the same workspace.



## Generate a library



Run `nx g @nrwl/react:lib my-lib` to generate a library.



> You can also use any of the plugins above to generate libraries as well.



Libraries are shareable across libraries and applications. They can be imported from `@vue-vite-monorepo-playground/mylib`.



## Development server



Run `nx serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.



## Code scaffolding



Run `nx g @nrwl/react:component my-component --project=my-app` to generate a new component.



## Build



Run `nx build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.



## Running unit tests



Run `nx test my-app` to execute the unit tests via [Jest](https://jestjs.io).



Run `nx affected:test` to execute the unit tests affected by a change.



## Running end-to-end tests



Run `nx e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io).



Run `nx affected:e2e` to execute the end-to-end tests affected by a change.



## Understand your workspace



Run `nx graph` to see a diagram of the dependencies of your projects.



## Further help



Visit the [Nx Documentation](https://nx.dev) to learn more.



## ☁ Nx Cloud



### Distributed Computation Caching & Distributed Task Execution






Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.



Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.



Visit [Nx Cloud](https://nx.app/) to learn more.