Nx + Angular + NestJS mono-repository starter with workflow automation.

	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:linux should 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: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;
• 🤷 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 shellcheck via 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

• Bash 5
• Node.js
• Yarn
• Git

• Yarn - preferred package manager for dependencies installation in the project root.
• npm - preferred package manager for dependencies installation in the functions folder.

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)

npx nx run tools:help

Using commitizen cli is mandatory.

Provided all dependencies are installed, and commitizen cli is installed as a global dependency, this command must be used.

git cz

The GitBook documentation is generated based on this GitHub repo.

• GitBook documentation

Application deployments and autogenerated engineering documentation.

• Client
• Elements
• Documentation
  • Compodoc
  • Storybook
  • Unit test reports
  • E2E test reports
  • Changelogs

npx nx generate client-feature client-<feature-name> --tags=scope:client-<feature-name>,type:feature

npx nx generate client-ui client-<feature-name> --tags=scope:client-<feature-name>,type:ui

npx nx generate client-store client-store-<feature-name> --tags=scope:client-store-<feature-name>,type:data-access

npx nx generate client-util client-util-<feature-name> --tags=scope:client-util-<feature-name>,type:util

npx nx generate module-boundaries

This project was generated using Nx.

🔎 Nx is a set of Angular CLI power-ups for modern development.

• Nx Documentation
• 30-minute video showing all Nx features
• Interactive Tutorial

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 plugins which are added to the workspace:

To generate an application run:

npx nx g @nx/angular:app my-app

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:

npx nx g @nx/angular:lib my-lib

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:

npx nx serve my-app

Navigate to http://localhost:4200/.

The app will automatically reload if you change any of the source files.

To generate a new component run:

npx nx g @nx/angular:component my-component --project=my-app

To build the project run:

npx nx build my-app

The build artifacts will be stored in the dist/ directory.

Use the --prod flag for a production build.

To execute the unit tests run:

npx nx test my-app

To execute the unit tests affected by a change run:

npx nx affected:test

To execute the end-to-end tests run:

npx nx e2e my-app

To execute the end-to-end tests affected by a change run:

npx nx affected:e2e

To see a diagram of the dependencies of the projects run:

npx nx dep-graph

npx nx g @nx/angular:storybook-configuration project-name

Print supported workspace commands

npx nx run tools:help

Visit the Nx Documentation to learn more.

• Nrwl Nx

• Angular
• Angular CLI
• Angular Material
• Apollo Angular
• Material Design Guidelines
• NgRx

• NestJS
• Firebase JS Reference
• Express GraphQL Server
• Angular Firebase: Apollo Server
• GRPC

• Cypress
• Jest

• Compodoc

• GitHub Actions

• Trunk based development