Nx Angular NestJS Starter is a powerful template designed for building scalable Angular and NestJS applications using Nx. It leverages modern development practices to enhance productivity and maintainability.
- Monorepo Support: Manage multiple Angular applications and libraries in a single repository.
- Optimized Build Process: Leverage Nx's caching and task running capabilities for faster builds.
- Integrated Testing: Built-in support for unit and end-to-end testing.
- Customizable Configuration: Easily adjust settings to fit your project's needs.
| Trigger | Badge | |
|---|---|---|
| ℹ️ | Manual, Scheduled (weekly) |  |
| ℹ️ | Manual |  |
| ℹ️ | PR merge event (destination: trunk) |  |
| ℹ️ | Manual |  |
| ℹ️ | PR merge event (destination: trunk) |  |
| ℹ️ | Scheduled (weekly) |  |
| ℹ️ | PR open event (destination: trunk) |  |
In order to run own copy of the project one must fulfill the following requirements.
- 🏆 Debian based Linux -
recommended- check out this dev setup instructions to facilitate setting up the dev environment;
- given that the dev environment is set up, the command
yarn install:all:linuxshould install everything needed to work with the project;
- 🆗 OSX -
should work due to similarity to 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:osxshould install everything needed to work with the project; - the automation scripts support the OS with relatively high probability, but it has not been tested;
- 🤷 Windows -
should work, but no guarantees- one will have to figure out oneself how to set up the dev environment;
- one will have to figure out oneself how to install
protolint, see available installation options; - given that the dev environment is set up, the following commands should be used to install
shellcheckvia PowerShell;iwr -useb get.scoop.sh | iex scoop install shellcheck
- recommended shell: Git for Windows >
Git BASH; - configure Git to use LF as a carriage return
git config --global core.autocrlf false git config --global core.eol lf
- Yarn - preferred package manager for dependencies installation in the project root.
- npm - preferred package manager for dependencies installation in the
functionsfolder.
- Clone the repository:
git clone https://github.com/rfprod/nx-ng-starter.git- Navigate to the project directory:
cd ./nx-ng-starter- Install dependencies:
yarn install --frozen-lockfile- Run the application:
yarn startThe 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)
npx nx run tools:helpUsing commitizen cli is mandatory.
Provided all dependencies are installed, and commitizen cli is installed as a global dependency, this command must be used.
git czThe GitBook documentation is generated based on this GitHub repo.
Application deployments and autogenerated engineering documentation.
npx nx generate client-feature client-<feature-name> --tags=scope:client-<feature-name>,type:featurenpx nx generate client-ui client-<feature-name> --tags=scope:client-<feature-name>,type:uinpx nx generate client-store client-store-<feature-name> --tags=scope:client-store-<feature-name>,type:data-accessnpx nx generate client-util client-util-<feature-name> --tags=scope:client-util-<feature-name>,type:utilnpx nx generate module-boundariesnpx nx dep-graphThis project was generated using Nx.
Refer to the CONTRIBUTING.md file for guidelines.