@nrwl/nest
Advanced tools
Package description
@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.
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-appGenerate 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-libServe 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-appBuild 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-appTest 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-appThe @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.
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 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
🔎 Smart, Extensible Build Framework
Nx is a smart and extensible build framework to help you architect, test, and build at any scale — integrating seamlessly with modern technologies and frameworks while providing a distributed graph-based task execution, computation caching, smart rebuilds of affected projects, powerful code generators, editor support, GitHub apps, and more.
Nx provides distributed graph-based task execution and computation caching.
Nx is smart. It analyzes your workspace and figures out what can be affected by every code change. That's why Nx doesn't rebuild and retest everything on every commit--it only rebuilds what is necessary .
Nx partitions commands into a graph of smaller tasks. Nx then runs those tasks in parallel, and it can even distribute them across multiple machines without any configuration.
Nx also uses a distributed computation cache. If someone has already built or tested similar code, Nx will use their results to speed up the command for everyone else.
Nx helps scale your development from one team building one application to many teams building multiple frontend and backend applications all in the same workspace. When using Nx, developers have a holistic dev experience powered by an advanced CLI (with editor plugins), capabilities for controlled code sharing and consistent code generation.
Nx is an open platform with plugins for many modern tools and frameworks. It has support for TypeScript, React, Angular, Cypress, Jest, Prettier, Nest.js, Next.js, Storybook, Ionic among others. With Nx, you get a consistent dev experience regardless of the tools used.
Using npx
npx create-nx-workspace
Using npm init
npm init nx-workspace
Using yarn create
yarn create nx-workspace
The create-nx-workspace command will ask you to select a preset, which will configure some plugins and create your applications to help you get started.
? What to create in the new workspace (Use arrow keys)
❯ empty [an empty workspace with a layout that works best for building apps]
npm [an empty workspace set up to publish npm packages (similar to and compatible with yarn workspaces)]
react [a workspace with a single React application]
angular [a workspace with a single Angular application]
next.js [a workspace with a single Next.js application]
gatsby [a workspace with a single Gatsby application]
nest [a workspace with a single Nest application]
express [a workspace with a single Express application]
web components [a workspace with a single app built using web components]
react-express [a workspace with a full stack application (React + Express)]
angular-nest [a workspace with a full stack application (Angular + Nest)]
Select the preset that works best for you.
? Workspace name (e.g., org name) happyorg
? What to create in the new workspace nest
? Application name myapp
? Default stylesheet format CSS
You can also select empty and add @nrwl/nest plugin using yarn or npm, and then generate a new express app using nx g @nrwl/nest:app myapp.
If it's your first Nx project, the command will recommend you to install the nx package globally, so you can invoke nx directly without going through yarn or npm.
nx serve myapp to serve the newly generated application!nx test myapp to test it.You are good to go!
Even though Nx isn't technology specific, we provide 3 separate flavours of the documentation site to it make it easier for you to get up and running. For every link below, you will be able to select whether you want your examples to be written in React, Node or Angular.
| Scale React Development with Nx | Nx Workspaces | Advanced Nx Workspaces |
|
|
|
|
FAQs
The Nx Plugin for Nest contains executors and generators for allowing your workspace to create powerful Nest best in class APIs.
The npm package @nrwl/nest receives a total of 248,356 weekly downloads. As such, @nrwl/nest popularity was classified as popular.
We found that @nrwl/nest demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Emerging ransomware groups drive a surge in activity in early 2024, with increasing software supply chain attacks predicted to impact critical industries reliant on third-party software.
Security News
In June 2023, Google sold all Google Domains accounts to Squarespace but more than a dozen customers have had their domains hijacked in the last week due to weak security defaults and migration issues.
![Massive Automated Spam Campaign Abuses GitHub to Flood npm Registry with Thousands of Garbage Tea[.]xyz Packages](https://cdn.sanity.io/images/cgdhsj6q/production/a74d1072ff2bb5cb96a404be58a649931ced2ba5-1024x1024.webp?w=400&fit=max&auto=format)
Security News
In a reprisal of their previous Tea[.]xyz spam campaign, a new wave of thousands of garbage packages are hitting npm, to artificially inflate the number of dependents for spammers' projects.
