@nrwl/nest

What is @nrwl/nest?

@nrwl/nest is a package that provides tools and utilities for building and managing NestJS applications within an Nx workspace. It helps in creating, developing, and testing NestJS applications and libraries with ease.

What are @nrwl/nest's main functionalities?

Generate NestJS Application

This command generates a new NestJS application within an Nx workspace. It sets up the necessary files and configurations to get started with a NestJS application.

nx generate @nrwl/nest:application my-app

Generate NestJS Library

This command generates a new NestJS library within an Nx workspace. Libraries can be shared across multiple applications and can help in organizing code better.

nx generate @nrwl/nest:library my-lib

Serve NestJS Application

This command serves a NestJS application, making it available for development and testing. It starts the application and watches for changes, automatically restarting the server when files are modified.

nx serve my-app

Build NestJS Application

This command builds a NestJS application for production. It compiles the TypeScript code and bundles it into a format suitable for deployment.

nx build my-app

Test NestJS Application

This command runs the tests for a NestJS application. It uses Jest as the testing framework and provides a way to ensure the application works as expected.

nx test my-app

Other packages similar to @nrwl/nest

@nestjs/cli

The @nestjs/cli package provides a command-line interface for creating and managing NestJS applications. It offers similar functionalities to @nrwl/nest, such as generating applications and libraries, serving applications, and running tests. However, @nrwl/nest is specifically designed to work within an Nx workspace, providing additional benefits like better integration with other tools and improved project organization.

nx

The nx package is the core tool for managing monorepos and provides support for various frameworks, including NestJS. While @nrwl/nest is an extension specifically for NestJS, nx itself offers a broader range of functionalities for managing multiple projects and libraries within a single workspace. It provides tools for building, testing, and serving applications, as well as advanced features like dependency graph visualization and affected project detection.

lerna

Lerna is a popular tool for managing JavaScript projects with multiple packages. It helps in organizing code into separate packages and provides commands for bootstrapping, building, and publishing packages. While Lerna does not provide specific support for NestJS, it can be used in conjunction with other tools to manage NestJS applications and libraries within a monorepo.

README

---

---

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

• Nx Documentation and Guides
• Nx blog posts

Books

• Angular Enterprise Monorepo Patterns

Videos

• 5-minute video on how to get started with Nx.
• 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

Podcasts and Shows

• ngAir 140: Nx for Enterprise Angular Development
• ngHouston: NX Demo

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
vsavkin	FrozenPandaz	bcabanes