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

Trigger	Badge
PR open 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.

• Debian based Linux - recommended, check out this dev setup instructions to facilitate getting started
• OSX
• Windows - poorly supported

• Node.js
• NPM
• 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)

yarn workspace: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

Is generated based on GitHub repo.

• GitBook documentation

Applications as well as generated documentation, testing reports, and a custom changelog are deployed to Firebase.

• Client
• Elements

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

yarn workspace:schematic client-feature client-<feature-name> --tags=scope:client-<feature-name>,type:feature

yarn workspace:schematic client-ui client-ui-<feature-name> --tags=scope:client-ui-<feature-name>,type:ui

yarn workspace:schematic client-store client-store-<feature-name> --tags=scope:client-store-<feature-name>,type:data-access

yarn workspace:schematic client-util client-util-<feature-name> --tags=scope:client-util-<feature-name>,type:util

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 some plugins which you can add to your workspace:

To generate an application run:

ng g @nrwl/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:

ng g @nrwl/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:

ng 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:

ng g component my-component --project=my-app

To build the project run:

ng 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:

ng test my-app

To execute the unit tests affected by a change run:

npm run affected:test

To execute the end-to-end tests run:

ng e2e my-app

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

npm run affected:e2e

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

npm run dep-graph

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

ng run tools:help

Visit the Nx Documentation to learn more.

• Nrwl Nx

• Angular
• Angular CLI
• Angular Material
• Apollo Angular
• Material Design Guidelines
• NGXS

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

• Cypress
• Jest

• Compodoc

• GitHub Actions

• Trunk based development