@nrwl/angular

What is @nrwl/angular?

@nrwl/angular is a set of tools and libraries for building Angular applications and libraries within a monorepo. It is part of the Nx suite, which provides powerful, extensible dev tools for monorepos, enabling developers to manage multiple projects and libraries in a single repository.

What are @nrwl/angular's main functionalities?

Generate Angular Applications

This command generates a new Angular application within the monorepo. It sets up the necessary files and configurations to get started with a new Angular project.

nx generate @nrwl/angular:application my-app

Generate Angular Libraries

This command generates a new Angular library within the monorepo. Libraries can be shared across multiple applications, promoting code reuse and modularity.

nx generate @nrwl/angular:library my-lib

Run Angular Application

This command serves the specified Angular application, starting a development server and enabling live reloading for a smooth development experience.

nx serve my-app

Build Angular Application

This command builds the specified Angular application for production, optimizing the output for deployment.

nx build my-app

Test Angular Application

This command runs the unit tests for the specified Angular application, ensuring code quality and correctness.

nx test my-app

Other packages similar to @nrwl/angular

angular-cli

The Angular CLI is a command-line interface tool that helps to automate the development workflow of Angular applications. It provides similar functionalities to @nrwl/angular, such as generating applications and libraries, serving applications, and running tests. However, it is not specifically designed for monorepos and does not offer the same level of integration and tooling for managing multiple projects within a single repository.

lerna

Lerna is a tool for managing JavaScript projects with multiple packages. It optimizes the workflow around managing multi-package repositories with git and npm. While Lerna is not specific to Angular, it can be used in conjunction with Angular projects to manage monorepos. However, it lacks the Angular-specific generators and integrations provided by @nrwl/angular.

nx

Nx is a set of extensible dev tools for monorepos, which includes support for Angular, React, and other frameworks. While @nrwl/angular is a part of the Nx suite specifically tailored for Angular, Nx itself provides a broader set of tools and capabilities for managing monorepos, including advanced caching, dependency graph visualization, and more.

README

---

---

What is Nx?

🔎 Extensible Dev Tools for Monorepos.

Nx Helps You

Use Modern Tools

Using Nx, you can add TypeScript, Cypress, Jest, Prettier, and Nest into your dev workflow. Nx sets up these tools and allows you to use them seamlessly. Nx fully integrates with the other modern tools you already use and love.

Build Full-Stack Applications

With Nx, you can build full-stack applications using modern frameworks. You can share code between the frontend and the backend. And you can use the same build/test/serve commands throughout the whole dev experience.

Develop like Google, Facebook, and Microsoft

With Nx, you can develop multiple full-stack applications holistically and share code between them all in the same workspace. Nx provides advanced tools which help you scale your enterprise development. Nx also helps enforce your organization’s standards and community best practices.

Getting Started

Creating an Nx Workspace

Using npx

npx create-nx-workspace myworkspace

Using npm init

npm init nx-workspace myworkspace

Using yarn create

yarn create nx-workspace myworkspace

If it's your first Nx project, the command will recommend you to install @nrwl/cli globally, so you can invoke nx directly without going through yarn or npm.

Adding Nx to an Existing Angular CLI workspace

If you are an Angular user, you can also add Nx to your existing Angular CLI project by running:

ng add @nrwl/workspace

Creating First Application

By default, an Nx workspace starts blank. There are no applications to build, serve, and test. To create one, you need to add capabilities to the workspace.

To add an Angular app, run:

yarn add @nrwl/angular
nx g @nrwl/angular:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/angular
nx g @nrwl/angular:app myapp # or just "nx g myapp"

To add a React app, run:

yarn add @nrwl/react
nx g @nrwl/react:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/react
nx g @nrwl/react:app myapp # or just "nx g myapp"

To add a web components app, run:

yarn add @nrwl/web
nx g @nrwl/web:app myapp # or just "nx g myapp"

npm install --save-dev @nrwl/web
nx g @nrwl/web:app myapp # or just "nx g myapp"

If nx g fails, use: yarn nx g @nrwl/web:app myapp or npm run nx -- g @nrwl/web:app myapp.

Regardless of what framework you chose, the resulting file tree will look like this:

<workspace name>/
├── apps/
│   ├── myapp/
│   └── myapp-e2e/
├── libs/
├── tools/
├── nx.json
├── package.json
├── tsconfig.json
└── tslint.json

Serving Application

• Run nx serve myapp to serve the newly generated application!
• Run nx test myapp to test it.
• Run nx e2e myapp-e2e to run e2e tests for it.

Angular users can also run ng g/serve/test/e2e.

You are good to go!

Quick Start & Documentation

Documentation

• Nx Documentation and Guides
• Nx blog posts

Books

• Enterprise Monorepo Patterns

Videos

• Nx Quickstart - How to Scale a JavaScript Project
• Video course on using Nx Workspaces

Talks

• Angular at Large Organizations
• Nx: The New Way to Build Enterprise Angular Apps
• Supercharging the Angular CLI
• Hands on Full Stack development with Nx and Bazel

Misc

• nx-examples repo has branches for different nx comments to display expected behavior and example app and libraries. Check out the branch (workspace, ngrx...) to see what gets created for you. More info on readme.
• xplat - Cross-platform tools for Nx workspaces

Want to help?

If you want to file a bug or submit a PR, read up on our guidelines for contributing.

Core Team

Victor Savkin	Jason Jean	Benjamin Cabanes	Brandon Roberts	Wes Grimes
vsavkin	FrozenPandaz	bcabanes	brandonroberts	wesleygrimes