@app/nx-ng-starter documentation

Nx Ng Starter

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

Commitizen friendly

Workflows

Trigger Badge
:information_source: Manual, Scheduled (weekly) codeql-analysis
:information_source: Manual build-docker
:information_source: PR merge event (destination: trunk) publish-packages
:information_source: Manual test-e2e
:information_source: PR merge event (destination: trunk) trunk
:information_source: Scheduled (weekly) validate-codeowners
:information_source: PR open event (destination: trunk) validate-pr

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 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;Example :
      iwr -useb get.scoop.sh | iex
scoop install shellcheck
    • recommended shell: Git for Windows > Git BASH;
    • configure Git to use LF as a carriage returnExample :
      git config --global core.autocrlf false
git config --global core.eol lf

Core dependencies

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)

Example :
npx nx run tools:help

Committing changes to the 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.

Example :
git cz

GitBook documentation

The GitBook documentation is generated based on this GitHub repo.

Firebase deployments

Application deployments and autogenerated engineering documentation.

Workspace generators

Library generators

feature library

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

ui library

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

data-access library

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

util library

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

Audit module boundaries

Example :
npx nx generate module-boundaries

General Tooling

This project was generated using Nx.

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

Quick Start & Documentation

Workspace capabilities

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:

Application type Command Domain
Angular nx add @nx/angular Web client
Nest nx add @nx/nest API
Node nx add @nx/node Automation
Storybook nx add @nx/storybook UI testing
Cypress nx add @nx/cypress E2E testing
Jest nx add @nx/jest Unit testing

Generating an application

To generate an application run:

Example :
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.

Generating a library

To generate a library run:

Example :
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.

Running a development server

To start a dev server run:

Example :
npx nx 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:

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

Building applications

To build the project run:

Example :
npx nx 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:

Example :
npx nx test my-app

To execute the unit tests affected by a change run:

Example :
npx nx affected:test

End-to-end testing with Cypress

To execute the end-to-end tests run:

Example :
npx nx e2e my-app

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

Example :
npx nx affected:e2e

Understanding the workspace

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

Example :
npx nx dep-graph

Generating a storybook for a feature library or UI library

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

Tools help

Print supported workspace commands

Example :
npx nx run tools:help

Further help

Visit the Nx Documentation to learn more.

Technology reference

Workspace

Client

Server

Testing

Documentation

CI

Development methodology

results matching ""

    No results matching ""