5 min read

Using Monorepos

Monorepos allow you to manage and organize multiple projects in a single directory so they are easier to work with. Learn how to deploy a monorepo here.
Table of Contents

Monorepos allow you to manage multiple projects in a single directory. They are a great way to organize your projects and make them easier to work with.

Get started with monorepos on Vercel in a few minutes by using one of our monorepo quickstart templates.

Use the New Project button to import your monorepo Project from within your Personal or Team Account.

If you'd like to deploy multiple different directories within the same Git repository, you can do so by creating a separate Project for each directory and configuring the Root Directory setting for it.

To achieve this, import your Git repository multiple times, edit the Root Directory in the Project Configuration for each import, and choose the corresponding Project. This will configure the Root Directory of each Project to its relevant directory in the repository.

Selecting a Root Directory for one of your new Projects.

Once you've created a separate Project for each of the directories within your Git repository, every commit will issue a Deployment for all connected Projects and display the resulting URLs on your pull requests and commits:

An example of Deployment URLs provided for a Deployment through Git.

The number of Vercel Projects connected with the same Git repository is limited depending on your plan.

Vercel CLI should always be invoked from the monorepo root, not the subdirectory. You should use Vercel CLI 20.1.0 or newer.

First, run vercel link to select the Vercel Project. You'll need to select one at a time.

If you're working in a monorepo using the Git Integration, you can link multiple projects at once using vc link --repo. Visit CLI docs to learn more.

Once linked, subsequent commands such as vercel dev will use the selected Vercel Project. To switch to a different Project in the same monorepo, run vercel link again and select the new Project.

Alternatively, you can use git clone to create multiple copies of your monorepo in different directories and link each one to a different Vercel Project.

See this example of a monorepo with Yarn Workspaces.

Pushing a commit to your monorepo will create a Deployment for each of the connected Vercel projects.

If you want to cancel the Build Step for certain projects if their files didn't change, you can do so with the Ignored Build Step project setting.

If you have created a script to ignore the build step, you can skip the the script when redeploying or promoting your app to production. This can be done through the dashboard when you click on the Redeploy button, and unchecking the Use project's Ignore Build Step checkbox.

When you use Turborepo, you can intelligently cancel builds using turbo-ignore.

Whether or not your deployments are queued depends on the amount of Concurrent Builds you have available. Hobby plans are limited to 1 Concurrent Build, while Pro or Enterprise plans can customize the amount on the "Billing" page in the team settings.

Learn more about Concurrent Builds.

After having set up your monorepo as described above, each of the directories will be a separate Vercel project, and therefore be available on a separate domain.

If you'd like to host multiple projects under a single domain, you can create a new project, assign the domain in the project settings, and proxy requests to the other upstream projects. The proxy can be implemented using a vercel.json file with the rewrites property, where each source is the path under the main domain and each destination is the upstream project domain.

Pushing a commit to a Git repository that is connected with multiple Vercel projects will result in multiple deployments being created and built in parallel for each.

To access source files outside the Root Directory, enable the Include source files outside of the Root Directory in the Build Step option in the Root Directory section within the project settings.

For information on using Yarn workspaces, see Deploying a Monorepo Using Yarn Workspaces to Vercel.

Vercel projects created after August 27th 2020 23:50 UTC have this option enabled by default. If you're using Vercel CLI, at least version 20.1.0 is required.

Vercel CLI will accept Environment Variables instead of Project Linking, which can be useful for deployments from CI providers. For example:

VERCEL_ORG_ID=team_123 VERCEL_PROJECT_ID=prj_456 vercel

Learn more about Vercel CLI for custom workflows.

Yes. Turborepo is available on all plans.

When using Nx on Vercel with environment variables, you may encounter an issue where some of your environment variables are not being assigned the correct value in a specific deployment.

This can happen if the environment variable is not initialized or defined in that deployment. If that's the case, the system will look for a value in an existing cache which may or may not be the value you would like to use. It is a recommended practice to define all environment variables in each deployment for all monorepos.

With Nx, you also have the ability to prevent the environment variable from using a cached value. You can do that by using Runtime Hash Inputs . For example, if you have an environment variable MY_VERCEL_ENV in your project, you will add the following line to your nx.json configuration file:

"runtimeCacheInputs": ["echo $MY_VERCEL_ENV"]
Last updated on July 13, 2024