ntersol
v14.0.0
Published
## Handy Commands
Downloads
65
Readme
AngularStarter
Handy Commands
Generate a new library. Make sure to immediately commit the stub after creation to avoid conflicts in git.
ng generate library {libname}
Replace '{name}' with '{libname}' in both tsconfig.base.json and the generated package.json within the library you created.
Run storybook documentation
ng run {libname}:storybook
Build a package, append :production
for a prod build
ng build {libname}
nx run {libname}:build
Deploy update to NPM
nx run {libname}:publish
Deploy documentation website to https://ntersol.github.io/ui/
ng run showcase:deploy
Documentation Quick Links
Generating package documentation with storybook https://ntersol.atlassian.net/wiki/spaces/NTER/pages/1527939105/Generating+Package+Documentation
Stub Documentation
This project was generated using Nx.
🔎 Nx is a set of Extensible Dev Tools for Monorepos.
Quick Start & Documentation
10-minute video showing all Nx features
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:
- Angular
ng add @nrwl/angular
- React
ng add @nrwl/react
- Web (no framework frontends)
ng add @nrwl/web
- Nest
ng add @nrwl/nest
- Express
ng add @nrwl/express
- Node
ng add @nrwl/node
There are also many community plugins you could add.
Generate an application
Run ng g @nrwl/angular: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 ng g @nrwl/angular:lib my-lib
to generate a library.
Replace '{name}' with 'my-app' in both tsconfig.base.json and the generated package.json within the library you created.
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 @ntersol/{lib-name}
.
Development server
Run ng 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 ng g component my-component --project=my-app
to generate a new component.
Build
Run ng 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 ng test my-app
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 ng e2e my-app
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 dep-graph
to see a diagram of the dependencies of your projects.
Further help
Visit the Nx Documentation to learn more.
☁ Nx Cloud
Computation Memoization in the Cloud
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.