Deploying Next.js applications to Vercel
Starting from Nx 11, your Next.js application should already be ready for deployment to Vercel.
Configure your Vercel project's settings appropriately
New Vercel project
- If you are "importing" your Nx workspace's repository for the first time, make sure you do not choose a root directory as part of the repo selection process (therefore leaving it to be the root of the full repo/workspace)
- Ensure the Next.js "Framework Preset" is selected
- Expand the "Build and Output Settings" and toggle the override switch for the build command. For example, for an application named
tuskdeskthe value will look like this:
npx nx build tuskdesk --prod
- Toggle the override switch for the output directory. Point it to the
.nextdirectory inside the built app:
Therefore, our full configuration (based on a repo called "nx-workspace" and a project called "tuskdesk") will look like this:
Existing Vercel project
If you have an existing project on Vercel then the exact same guidance applies as for the section above, it's just that you will need to update the project's existing settings.
When everything is updated appropriately, for our
tuskdesk example we would see the following in our "General" settings UI:
Skipping build if the application is not affected
One of the core features of Nx is to run code quality checks and builds only for projects that are affected by recent code changes. We can use Vercel's ignored build step feature to only build our application if it is affected.
We are going to achieve this by creating a shell script in our Nx workspace that will be invoked by Vercel.
1 2# Name of the app to check. Change this to your application name! 3APP=tuskdesk 4 5# Determine version of Nx installed 6NX_VERSION=$(node -e "console.log(require('./package.json').devDependencies['@nrwl/workspace'])") 7TS_VERSION=$(node -e "console.log(require('./package.json').devDependencies['typescript'])") 8 9# Install @nrwl/workspace in order to run the affected command 10npm install -D @nrwl/workspace@$NX_VERSION --prefer-offline 11npm install -D typescript@$TS_VERSION --prefer-offline 12 13# Run the affected command, comparing latest commit to the one before that 14npx nx affected:apps --plain --base HEAD~1 --head HEAD | grep $APP -q 15 16# Store result of the previous command (grep) 17IS_AFFECTED=$? 18 19if [ $IS_AFFECTED -eq 1 ]; then 20 echo "🛑 - Build cancelled" 21 exit 0 22elif [ $IS_AFFECTED -eq 0 ]; then 23 echo "✅ - Build can proceed" 24 exit 1 25fi
There are a few points worth noting about this script.
Firstly, you might have noticed that we are running
npm install (feel free to use
yarn add instead) in this script, as a result running it will take some time. Having said that, it is usually still much faster than installing all dependencies and running the build of your application unconditionally.
Secondly, this script only compares changes introduced in a single latest commit. So if you push multiple new commits - the script will only check if your application is affected by changes in the latest commit. In the future, there should be an environment variable in Vercel to determine what the base for the affected comparison should be.
Once you've saved this script in your Nx workspace, for example in
tools/ignore-vercel-build.sh, we need to point Vercel to use this script.
Naturally, you can continue on and set any additional Environment Variables etc that may be appropriate for your projects, but we have now covered the key points needed to deploy Next.js projects from Nx workspaces on Vercel!