@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?

🔎 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.

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 a web components app, run:

yarn add --dev @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"

To add an Angular app, run:

yarn add --dev @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 --dev @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"

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!

Documentation

• Nx Documentation and Guides
• Nx blog posts

Quick Start Videos

Angular

React

Books

• Effective React Development with Nx
• Angular Enterprise Monorepo Patterns

Videos

• Building Angular full-stack applications in a monorepo.
• Building React full-stack applications in a monorepo.
• 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