index
This repository contains modern and scalable web application code, additional utility applications/tools, and various libraries.
Getting startedโ
Once the code is pulled locally, open a command prompt and run npm install
in the root repo directory (/open-system).
More information can be found in the Open System documentation.
Buildโ
Run nx build open-system
to build the project. The build artifacts will be stored in the dist/
directory. Use the --prod
flag for a production build.
Development serverโ
Run nx serve open-system
for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
Environment Configuration Help
If you run into any issues while trying to run any of the above steps, please reach out to Patrick.Sullivan.
Plug-Insโ
This repository uses the below plug-ins:
Generate an applicationโ
Run nx g @nx/react:app open-system
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 @nx/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 @open-system/my-lib
.
Code scaffoldingโ
Run nx g @nx/react:component my-component --project=open-system
to generate a new component.
Running unit testsโ
Run nx test open-system
to execute the unit tests via Jest.
Run nx affected:test
to execute the unit tests affected by a change.
Running end-to-end testsโ
Run nx e2e open-system
to execute the end-to-end tests via Cypress.
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.
โ 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 to learn more.
Contributors โจโ
Thanks goes to these wonderful people (emoji key):
Patrick Sullivan ๐จ ๐ป ๐ง ๐ โ ๏ธ | Tyler Benning ๐จ | |||||
Add your contributions |
This project follows the all-contributors specification. Contributions of any kind welcome!