Nx

• Start Here
  • Getting Started
  • Installation
  • Why Nx?
  • 5 min Tutorials
    • Package-Based Monorepo
    • Integrated Monorepo
    • React Standalone
    • Angular Standalone
    • Node Standalone
• Core Tutorial
  • 1 - Create Blog
  • 2 - Create CLI
  • 3 - Share Assets
  • 4 - Build Affected Projects
  • 5 - Automatically Detect Dependencies
  • 6 - Summary
• React Monorepo Tutorial
  • 1 - Code Generation
  • 2 - Project Graph
  • 3 - Task Running
  • 4 - Workspace Optimization
  • 5 - Summary
• React Standalone Tutorial
  • 1 - Code Generation
  • 2 - Project Graph
  • 3 - Task Running
  • 4 - Task Pipelines
  • 5 - Summary
• Angular Monorepo Tutorial
  • 1 - Code Generation
  • 2 - Project Graph
  • 3 - Task Running
  • 4 - Workspace Optimization
  • 5 - Summary
• Angular Standalone Tutorial
  • 1 - Code Generation
  • 2 - Project Graph
  • 3 - Task Running
  • 4 - Task Pipelines
  • 5 - Summary
• Node Server Tutorial
  • 1 - Code Generation
  • 2 - Project Graph
  • 3 - Task Running
  • 4 - Task Pipelines
  • 5 - Docker Target
  • 6 - Summary
• Core Features
  • Run Tasks
  • Cache Task Results
  • Share Your Cache
  • Explore the Graph
  • Distribute Task Execution
  • Integrate with Editors
  • Automate Updating Dependencies
  • Enforce Project Boundaries
• Plugin Features
  • Use Task Executors
  • Use Code Generators
• Concepts
  • Integrated Repos vs. Package-Based Repos vs. Standalone Apps
  • Mental Model
  • How Caching Works
  • Improve Worst Case CI Times
  • Task Pipeline Configuration
  • Affected
• More Concept Guides »
• More Concepts
  • Customizing Inputs
  • Incremental Builds
  • Illustrated Distributed Task Execution
  • Nx and Turborepo
  • Monorepos
  • Dependency Management
  • Code Sharing
  • Using Nx at Enterprises
  • Nx Daemon
  • Nx and the Angular CLI
  • Folder Structure
  • Nx Devkit and Angular Devkit
  • Micro Frontend Architecture
  • Applications and Libraries
  • Creating Libraries
  • Library Types
  • Grouping Libraries
  • Buildable and Publishable Libraries
  • How the Project Graph is Built
  • Nx and the Nx Wrapper
  • Managing your Global Nx Installation
• All Recipes »
  • CI Setup
  • Adopting Nx
• Reference
  • Commands
  • nx.json
  • Project Configuration
  • .nxignore
  • Environment Variables
  • Glossary
• Deprecated
  • workspace.json
  • workspace-lint
  • Workspace Generators
  • Workspace Executors
  • defaultCollection
  • runtimeCacheInputs
  • globalImplicitDependencies
  • Storybook deprecated docs
    • Angular: Information about the Storybook targets
    • Angular: The browserTarget
    • Angular: Storybook Migration to webpackFinal
    • Angular: Upgrading to Storybook 6
    • React: Storybook Migration to webpackFinal and the Nx Addon
    • React: Upgrading to Storybook 6
• See Also
  • Site Map

Recipes

• Getting Started
  • Set up a new workspace
• Nx Console
  • Nx Console Telemetry
  • Nx Console Generate Command
  • Nx Console Run Command
  • Nx Console Add Dependency Command
  • Nx Console Project Pane
  • Nx Console Keyboard Shortcuts
• CI
  • CI Setup
  • Prepare applications for deployment via CI
  • Setting up Azure Pipelines
  • Setting up CircleCI
  • Setting up GitHub Actions
  • Setting up Jenkins
  • Setting up GitLab
  • Setting up Bitbucket
  • Troubleshooting Nx Install Issues
• Adopting Nx
  • NPM/Yarn/PNPM workspaces
  • Add to any Project
  • From CRA
  • From Angular CLI
  • Nx and Lerna
  • From AngularJS
  • Preserving Git Histories
  • Manual migration
• Adopting Nx From Angular CLI
  • From Angular CLI
  • From Angular CLI to Integrated
  • From Angular CLI Manually
  • From Multiple Angular CLI Repos
• Executors
  • Use Executor Configurations
  • Running Custom Commands
• Environment Variables
  • Define Environment Variables
  • Use Environment Variables in React
  • Use Environment Variables in Angular
• Module Federation and Micro Frontends
  • Faster Builds with Module Federation
  • Setup Module Federation with SSR for Angular and React
  • Advanced Micro Frontends with Angular using Dynamic Federation
  • Nx Micro-Frontend Example
• Storybook
  • Publishing Storybook: One main Storybook instance for all projects
  • Publishing Storybook: One Storybook instance per scope
  • Publishing Storybook: One main Storybook instance using Storybook Composition
• Deployment
  • Deploying a Node App to Fly.io
  • Add and Deploy Netlify Edge Functions with Node
  • Deploying AWS lambda in Node.js
  • Serverless deployment with Deno Deploy
  • Add and Deploy Netlify Edge Functions with Deno
  • Deploying Next.js applications to Vercel
• Database
  • Using Prisma with NestJS
  • Using Mongo with Fastify
  • Using Redis with Fastify
  • Using Postgres with Fastify
  • Using PlanetScale with Serverless Fastify
• Enforce Module Boundaries
  • Ban Dependencies with Certain Tags
  • Tag in Multiple Dimensions
  • Ban External Imports
  • Tags Allow List
• Example Repos
  • Powering Up React Development With Nx
  • Using Apollo GraphQL
  • Large Repo and Caching
  • Large Repo and DTE
• Other
  • Run Root-Level NPM Scripts with Nx
  • Disable Graph Links Created from Analyzing Source Files
  • Workspace Watching
  • Advanced Update Nx
  • JavaScript and TypeScript
  • React Native with Nx
  • Remix with Nx
  • Adding Images, Fonts, and Files
  • Setup incremental builds for Angular applications
  • Profiling Build Performance
  • Using ESLint in Nx Workspaces
  • Configuring Browser Support
  • Using Tailwind CSS in React
  • React 18 Migration
  • Using Tailwind CSS with Angular projects
  • Using NgRx
  • Using Data Persistence operators
  • Find the Last Successful Commit in Azure Pipelines
  • Troubleshoot Cache Misses
  • Export Project Graph
  • Resolve Circular Dependencies
  • Include All package.json Files as Projects
  • Include Assets in Build
  • Identify Dependencies Between Folders
  • Rescope Packages from @nrwl to @nx
  • Standalone NgRx APIs

Plugins

• Intro
  • Getting Started with Plugins
• Plugin Registry
• 5 Min Tutorials
  • Create a Local Plugin
  • Maintain a Published Plugin
• Recipes
  • Write a Simple Executor
  • Compose Executors
  • Write a Simple Generator
  • Compose Generators
  • Provide Options for Generators
  • Create Files
  • Modify Files
  • Write a Migration
  • Create a Preset
  • Modify the Project Graph
  • Identify Custom Projects

Cloud

• Intro
  • What is Nx Cloud?
• Set Up
  • Record Non-Nx Commands
  • Enable GitHub PR Integration
  • Enable Bitbucket Cloud PR Integration
  • Enable GitLab MR Integration
• Account Management
  • Users
  • Authenticate with Google Identity
  • Access Tokens
  • Security Scenarios
  • End to End Encryption
• On Prem
  • Get Started
  • Authenticate with a Single Admin
  • Authenticate with GitHub
  • Authenticate with GitLab
  • Authenticate with BitBucket
  • Authenticate via SAML
  • Advanced Configuration
  • Kubernetes Setup
  • Standalone
• Reference
  • Configuration Options
  • nx-cloud CLI
  • Environment Variables
  • Server API Reference
  • Release Notes

Packages

• angular
  • documents
    • Overview
    • Angular and Nx Version Matrix
  • executors
    • delegate-build
    • ng-packagr-lite
    • package
    • webpack-browser
    • webpack-dev-server
    • webpack-server
    • module-federation-dev-server
    • module-federation-dev-ssr
  • generators
    • add-linting
    • application
    • component
    • component-cypress-spec
    • component-story
    • component-test
    • convert-tslint-to-eslint
    • directive
    • init
    • library
    • library-secondary-entry-point
    • remote
    • move
    • convert-to-with-mf
    • host
    • ng-add
    • ngrx
    • ngrx-feature-store
    • ngrx-root-store
    • pipe
    • scam-to-standalone
    • scam
    • scam-directive
    • scam-pipe
    • setup-mf
    • setup-ssr
    • setup-tailwind
    • stories
    • storybook-configuration
    • cypress-component-configuration
    • web-worker
• create-nx-plugin
• create-nx-workspace
• cypress
  • documents
    • Overview
    • Component Testing
    • v11 Migration Guide
  • executors
    • cypress
  • generators
    • init
    • cypress-project
    • cypress-e2e-configuration
    • cypress-component-configuration
    • migrate-to-cypress-11
• detox
  • documents
    • Overview
  • executors
    • build
    • test
  • generators
    • init
    • application
• devkit
  • documents
    • Overview
    • Ng CLI Adapter
• esbuild
  • documents
    • Overview
  • executors
    • esbuild
  • generators
    • init
    • esbuild-project
• eslint-plugin
  • documents
    • Overview
    • The enforce-module-boundaries rule
• expo
  • documents
    • Overview
  • executors
    • update
    • build
    • build-list
    • download
    • run
    • start
    • sync-deps
    • ensure-symlink
    • prebuild
    • install
    • export
    • submit
  • generators
    • init
    • application
    • library
    • component
• express
  • documents
    • Overview
  • generators
    • init
    • application
• jest
  • documents
    • Overview
  • executors
    • jest
  • generators
    • init
    • jest-project
• js
  • documents
    • Overview
  • executors
    • tsc
    • swc
    • node
    • verdaccio
  • generators
    • library
    • init
    • convert-to-swc
    • setup-verdaccio
    • setup-build
• linter
  • documents
    • Overview
  • executors
    • eslint
  • generators
    • workspace-rules-project
    • workspace-rule
• nest
  • documents
    • Overview
  • generators
    • application
    • convert-tslint-to-eslint
    • init
    • library
    • class
    • controller
    • decorator
    • filter
    • gateway
    • guard
    • interceptor
    • interface
    • middleware
    • module
    • pipe
    • provider
    • resolver
    • resource
    • service
• next
  • documents
    • Overview
    • How to configure Next.js plugins
  • executors
    • build
    • server
    • export
  • generators
    • init
    • application
    • page
    • component
    • library
    • custom-server
    • cypress-component-configuration
• node
  • documents
    • Overview
  • generators
    • init
    • application
    • library
    • setup-docker
• nx
  • documents
    • create-nx-workspace
    • init
    • generate
    • run
    • daemon
    • graph
    • run-many
    • affected
    • affected:graph
    • print-affected
    • format:check
    • format:write
    • migrate
    • report
    • list
    • workspace-lint
    • workspace-generator
    • connect-to-nx-cloud
    • reset
    • repair
    • exec
    • watch
    • show
    • view-logs
  • executors
    • noop
    • run-commands
    • run-script
• plugin
  • documents
    • Overview
  • executors
    • e2e
  • generators
    • plugin
    • create-package
    • e2e-project
    • migration
    • generator
    • executor
    • plugin-lint-checks
    • preset
• react
  • documents
    • Overview
  • executors
    • module-federation-dev-server
    • module-federation-ssr-dev-server
  • generators
    • init
    • application
    • library
    • component
    • redux
    • storybook-configuration
    • component-story
    • stories
    • component-cypress-spec
    • hook
    • host
    • remote
    • cypress-component-configuration
    • component-test
    • setup-tailwind
    • setup-ssr
• react-native
  • documents
    • Overview
  • executors
    • run-android
    • run-ios
    • bundle
    • build-android
    • build-ios
    • start
    • sync-deps
    • ensure-symlink
    • storybook
    • pod-install
  • generators
    • init
    • application
    • library
    • component
    • storybook-configuration
    • component-story
    • stories
    • upgrade-native
• rollup
  • executors
    • rollup
  • generators
    • init
    • rollup-project
• storybook
  • documents
    • Nx Storybook Plugin Overview
    • Set up Storybook for React Projects
    • Set up Storybook for Angular Projects
    • Storybook best practices for making the most out of Nx
    • Storybook 7 overview
    • Configuring Storybook on Nx
    • How to configure Webpack and Vite for Storybook
    • Setting up Storybook Composition with Nx
    • Angular: Set up Compodoc for Storybook on Nx
    • Angular: Configuring styles and preprocessor options
  • executors
    • storybook
    • build
  • generators
    • init
    • configuration
    • cypress-project
    • migrate-7
• tao
• vite
  • documents
    • Overview of the Nx Vite Plugin
    • Manually set up your project to use Vite.js
  • executors
    • dev-server
    • build
    • test
    • preview-server
  • generators
    • init
    • configuration
    • vitest
• web
  • documents
    • Overview
  • executors
    • file-server
  • generators
    • init
    • application
    • static-config
• webpack
  • documents
    • Overview of the Nx Webpack Plugin
    • How to configure webpack on your Nx workspace
    • Webpack plugins
  • executors
    • webpack
    • dev-server
    • ssr-dev-server
  • generators
    • init
    • webpack-project
• workspace
  • documents
    • Overview
    • Nx, NodeJS and Typescript Versions
  • executors
    • counter
  • generators
    • preset
    • move
    • remove
    • new
    • workspace-generator
    • run-commands
    • fix-configuration
    • npm-package
    • ci-workflow