Nx Ng Starter

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

Workflows

Info	Trigger	Badge
:information_source:	PR open event (destination: trunk)
:information_source:	PR merge event (destination: trunk)
:information_source:	PR merge event (destination: trunk)
:information_source:	PR merge event (destination: trunk)
:information_source:	Manual
:information_source:	Manual
:information_source:	Scheduled (weekly)
:information_source:	Manual, Scheduled (weekly)

Requirements

In order to run own copy of the project one must fulfill the following requirements.

Supported operating systems

• :trophy: 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;
• :ok: OSX - 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;
• :no_entry_sign: 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.

Core dependencies

• Bash 5
• Node.js
• Yarn
• Git

Preferred package manager

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

Package scripts reference

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

Committing changes to repo

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

GitBook documentation

The GitBook documentation is generated based on this GitHub repo.

• GitBook documentation

Firebase deployments

Application deployments and autogenerated engineering documentation.

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

Workspace generators

Generate a library

feature library

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

ui library

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

data-access library

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

util library

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

General Tooling

This project was generated using Nx.

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

Quick Start & Documentation

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

Adding capabilities to the 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 some plugins which can be added to the workspace:

Generating an application

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.

Generating a library

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.

Running a development server

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.

Code scaffolding

To generate a new component run:

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

Building applications

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.

Unit testing with Jest

To execute the unit tests run:

ng test my-app

To execute the unit tests affected by a change run:

npm run affected:test

End-to-end testing with Cypress

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

Understanding the workspace

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

npm run dep-graph

Generating a storybook for a feature or ui library

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

Tools help

ng run tools:help

Further help

Visit the Nx Documentation to learn more.

Technologies Reference

Workspace

• Nrwl Nx

Client

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

Server

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

Testing

• Cypress
• Jest

Documentation

• Compodoc

CI

• GitHub Actions

Development methodology

• Trunk based development