Deploying Nx to Vercel

Nx is an extensible build system with support for monorepos, integrations, and Remote Caching on Vercel.

Read the Intro to Nx docs to learn about the benefits of using Nx to manage your monorepos.

1. Ensure your Nx project is configured correctly

   If you haven't already connected your monorepo to Nx, you can follow the Getting Started on the Nx docs to do so.

   To ensure the best experience using Nx with Vercel, the following versions and settings are recommended:

   • Use version or later
   • Use version or later

   There are also additional settings if you are using Remote Caching

   All Nx starters and examples are preconfigured with these settings.

2. Import your project

   Create a new Project on the Vercel dashboard and import your monorepo project.

   Vercel handles all aspects of configuring your monorepo, including setting build commands, the Root Directory, the correct directory for npm workspaces, and the ignored build step.

3. Next steps

   Your Nx monorepo is now configured and ready to be used with Vercel!

   You can now setup Remote Caching for Nx on Vercel or configure additional deployment options, such as environment variables.

provides a way for you to tell Vercel if a build should continue or not. For more details and information on how to use , see the documentation.

Before using remote caching with Nx, do one of the following:

• Ensure the is set

or

• Set the option to at in your . For example:

To configure Remote Caching for your Nx project on Vercel, use the plugin.

1. Install the plugin

2. Configure the runner

   In your file you will find a field. Update this field so that it's using the installed :

   You can specify your and in your nx.json or set them as environment variables.

   Parameter	Description	Environment Variable / .env
   Vercel Access Token	Vercel access token with access to the provided team
   Vercel Team ID (optional)	The Vercel Team ID that should share the Remote Cache

   When deploying on Vercel, these variables will be automatically set for you.

3. Clear cache and run

   Clear your local cache and rebuild your project.