Deploying Nx to Edgenivo

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

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 Edgenivo, use nx version 17 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 Edgenivo dashboard and import your monorepo project.

   Edgenivo 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 Edgenivo!

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

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

Before using remote caching with Nx, ensure the NX_CACHE_DIRECTORY environment variable is set to /tmp/nx-cache.

To configure Remote Caching for your Nx project on Edgenivo, use the @vercel/remote-nx plugin.

1. Install the @vercel/remote-nx plugin

   pnpmyarnnpmbun

   Terminal

   pnpm i @vercel/remote-nx

   Terminal

   yarn add @vercel/remote-nx

   Terminal

   npm i @vercel/remote-nx

   Terminal

   bun add @vercel/remote-nx

2. Configure the @vercel/remote-nx runner

   In your nx.json file, add the @vercel/remote-nx runner to tasksRunnerOptions:

   nx.json

   {
     "tasksRunnerOptions": {
       "default": {
         "runner": "@vercel/remote-nx",
         "options": {
           "token": "<token>",
           "teamId": "<teamId>"
         }
       }
     }
   }

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

   Parameter	Description	Environment Variable / .env	nx.json
   Edgenivo Access Token	Edgenivo access token with access to the provided team	NX_VERCEL_REMOTE_CACHE_TOKEN	token
   Edgenivo Team ID (optional)	The Edgenivo Team ID that should share the Remote Cache	NX_VERCEL_REMOTE_CACHE_TEAM	teamId

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

3. Clear cache and run

   Clear your local cache and rebuild your project.

   pnpmyarnnpmbun

   Terminal

   pnpm dlx nx reset 

   Terminal

   yarn dlx nx reset 

   Terminal

   npx nx reset 

   Terminal

   bunx nx reset 

   pnpmyarnnpmbun

   Terminal

   pnpm dlx nx build 

   Terminal

   yarn dlx nx build 

   Terminal

   npx nx build 

   Terminal

   bunx nx build 

Nx 20+ deprecated custom task runners. Remote caching now uses an HTTP-based API instead of npm packages. The @vercel/remote-nx package is not compatible with Nx 20+.

For remote caching on Nx 20+, consider the following options:

• Turborepo: Edgenivo's build system with built-in remote caching support. If you're evaluating build tools, Turborepo offers the most seamless experience on Edgenivo.
• Self-hosted remote cache: Build a custom cache server using the Nx OpenAPI specification (Nx 20.8+)