nrwl/nx
Powerful, Extensible Dev Tools
repo name | nrwl/nx |
repo link | https://github.com/nrwl/nx |
homepage | https://nx.dev |
language | TypeScript |
size (curr.) | 33493 kB |
stars (curr.) | 6804 |
created | 2017-08-11 |
license | MIT License |
What is Nx?
🔎 Powerful, Extensible Dev Tools.
Nx Helps You
Develop like Google, Facebook, and Microsoft
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.
Use Intelligent Build System with Distributed 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 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 instead of rebuilding or retesting the code from scratch. This, in combination with Nx’s support for distributed and incremental builds, can help teams see up to 10x reduction in build and test times.
Use Modern Tools
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]
oss [an empty workspace with a layout that works best for open-source projects]
web components [a workspace with a single app built using web components]
angular [a workspace with a single Angular application]
angular-nest [a workspace with a full stack application (Angular + Nest)]
react [a workspace with a single React application]
react-express [a workspace with a full stack application (React + Express)]
next.js [a workspace with a single Next.js application]
Select the preset that works best for you. You can always add plugins later.
? Workspace name (e.g., org name) happyorg
? What to create in the new workspace web components [a workspace with a single app built using web components]
? Application name myapp
? Default stylesheet format CSS
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.
Angular users can also run ng g/serve/test/e2e
.
You are good to go!
Resources
Documentation
Quick Start Videos
Courses
Nx Demo & Tutorial Videos
-
Group all your stories into a single viewable Storybook with Nx
-
Nx Console - A Must-Have Visual Studio Code Extension for Angular Developers
-
Setting up distributed caching using Nx Cloud, @nrwl/nx-cloud
Books and Blogs
-
High Quality React apps with Nx & Cypress (April 2020)
-
Shell Library patterns with Nx and Monorepo Architectures (March 2020)
-
Tiny Angular application projects in Nx workspaces (March 2020)
Additional Resources
-
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.
Want to help?
If you want to file a bug or submit a PR, read up on our guidelines for contributing and watch this video that will help you get started.
Core Team
Victor Savkin | Jason Jean | Benjamin Cabanes | Brandon Roberts |
---|---|---|---|
vsavkin | FrozenPandaz | bcabanes | brandonroberts |
Jack Hsu | Jo Hanna Pearce | Jon Cammisuli | Isaac Mann |
---|---|---|---|
jaysoo | jdpearce | cammisuli | isaacplmann |
Tasos Bekos | Juri Strumpflohner | Philip Fulcher | Katerina Skroumpelou |
---|---|---|---|
bekos | juristr | philipjfulcher | mandarini |
Kirils Ladovs |
---|
kirjai |