Workspace Nx Package

What is Nx?

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

Best-in-Class Support for Monorepos

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.

Holistic Dev Experience Powered by an Advanced CLI and Editor Plugins

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.

Rich Plugin Ecosystem

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.

Getting Started

Creating an Nx Workspace

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.

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.

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.

Documentation & Resources

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.

• Nx Documentation and Guides
• Intro into Nx
• Interactive Tutorial with Videos

Quick Start Videos

• Scale Your React Development with Nx
• Scale your Node Development with Nx
• Modern Angular with Nx Dev Tools

Courses

Videos, Blogs, Books, Examples

• Nx Dev Tools for Monorepos, In-Depth Explainer (React)

• Nx Dev Tools for Monorepos, In-Depth Explainer (Angular)

• Youtube Channel with Nx-Related Videos

• Blog Posts About Nx

• Angular Enterprise Monorepo Patterns Book (free)

• Nx Examples Repo

Engage with the Core Team and the Community

• Nx Office Hours Playlist on YouTube. It's a regular YouTube stream where we talk all things Nx. Join the stream, ask questions, etc.
• Follow Nx on Twitter