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.
What is Nx?
🔎 Nx is a set of Angular CLI power-ups for modern development.
Nx Helps You
Use Modern Tools
Using Nx, you can add 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 Angular and Node.js frameworks such as Nest and Express. You can share code between the frontend and the backend. And you can use the familiar ng build/test/serve
commands to power whole dev experience.
Develop Like Google
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 helps enforce your organization’s standards and community best practices.
A la carte
Most importantly, you can use these power-ups a la carte. Just want to build a single Angular application using Cypress? Nx is still an excellent choice for that.
Does it replace Angular CLI?
Nx is not a replacement for Angular CLI. An Nx workspace is an Angular CLI workspace.
- You run same
ng build
, ng serve
commands. - You configure your projects in
angular.json
. - Anything you can do in a standard Angular CLI project, you can also do in an Nx workspace.
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
Adding Nx to an Existing Angular CLI workspace
If you already have a regular Angular CLI project, you can add Nx power-ups by running:
ng add @nrwl/schematics
Creating First Application
Unlike the CLI, an Nx workspace starts blank. There are no applications to build, serve, and test. To create one run:
ng g application myapp
The result will look like this:
<workspace name>/
├── README.md
├── angular.json
├── apps/
│ ├── myapp/
│ │ ├── browserslist
│ │ ├── jest.conf.js
│ │ ├── src/
│ │ │ ├── app/
│ │ │ ├── assets/
│ │ │ ├── environments/
│ │ │ ├── favicon.ico
│ │ │ ├── index.html
│ │ │ ├── main.ts
│ │ │ ├── polyfills.ts
│ │ │ ├── styles.scss
│ │ │ └── test.ts
│ │ ├── tsconfig.app.json
│ │ ├── tsconfig.json
│ │ ├── tsconfig.spec.json
│ │ └── tslint.json
│ └── myapp-e2e/
│ ├── cypress.json
│ ├── src/
│ │ ├── fixtures/
│ │ │ └── example.json
│ │ ├── integration/
│ │ │ └── app.spec.ts
│ │ ├── plugins/
│ │ │ └── index.ts
│ │ └── support/
│ │ ├── app.po.ts
│ │ ├── commands.ts
│ │ └── index.ts
│ ├── tsconfig.e2e.json
│ ├── tsconfig.json
│ └── tslint.json
├── libs/
├── nx.json
├── package.json
├── tools/
├── tsconfig.json
└── tslint.json
All the files that the CLI would have in a new project are still here, just in a different folder structure which makes it easier to create more applications and libraries in the future.
Serving Application
Run ng serve myapp
to serve the newly generated application!
You are good to go!
Quick Start & Documentation
Documentation
Books
Videos
Talks
Podcasts and Shows
Misc
Want to help?
If you want to file a bug or submit a PR, read up on our guidelines for contributing.
Core Team