Nx Ng Starter
Last updated
Was this helpful?
Last updated
Was this helpful?
+ + mono-repository starter with workflow automation.
PR open event (destination: trunk)
PR merge event (destination: trunk)
PR merge event (destination: trunk)
PR merge event (destination: trunk)
Manual
Manual
Scheduled (weekly)
Manual, Scheduled (weekly)
In order to run own copy of the project one must fulfill the following requirements.
- recommended
check out to facilitate setting up the dev environment;
given that the dev environment is set up, the command yarn install:all:linux should install everything needed to work with the project;
- should work due to the similarities with Linux
one will have to figure out oneself how to set up the dev environment;
given that the dev environment is set up, the command yarn install:all:osx should install everything needed to work with the project;
the automation scripts support the OS with relatively high probability, but it has not been tested;
- not recommended
one will have to figure out oneself how to set up the dev environment;
one will have to figure out oneself how to install required dependencies like protolint and shellcheck system wide;
the automation scripts support the OS with relatively low probability, but it has not been tested.
The project has lots of package scripts, check it in the package.json located in the project root, or use the following command (see terminal output for usage tips)
The GitBook documentation is generated based on this GitHub repo.
Application deployments and autogenerated engineering documentation.
feature libraryui librarydata-access libraryutil library🔎 Nx is a set of Angular CLI power-ups for modern development.
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 some plugins which can be added to the workspace:
ng add @nrwl/angular
ng add @nrwl/react
Web (no framework frontends)
ng add @nrwl/web
ng add @nrwl/nest
ng add @nrwl/express
ng add @nrwl/node
ng add @nrwl/storybook
ng add @nrwl/cypress
To generate an application run:
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.
To generate a library run:
You can also use any of the plugins above to generate libraries as well.
Libraries are sharable across libraries and applications.
It can be imported from @nx-ng-starter/mylib.
To start a dev server run:
Navigate to http://localhost:4200/.
The app will automatically reload if you change any of the source files.
To generate a new component run:
To build the project run:
The build artifacts will be stored in the dist/ directory.
Use the --prod flag for a production build.
To execute the unit tests run:
To execute the unit tests affected by a change run:
To execute the end-to-end tests run:
To execute the end-to-end tests affected by a change run:
To see a diagram of the dependencies of the projects run:
- preferred package manager for dependencies installation in the project root.
- preferred package manager for dependencies installation in the functions folder.
Using is mandatory.
Provided all dependencies are installed, and , this command must be used.
This project was generated using .
Visit the to learn more.
