Deployment to Vercel

Login using the Vercel CLI

vercel login

Navigate to the acap-v2/server directory using a terminal. Run the command to create a new Vercel project.

vercel link

Answer the required prompts:

• Set up "path/to/acap-v2/server"? [Y/n]: Press Enter
• Which scope should contain your project? Press Enter to select the default
• Link to existing project? [y/N]: Press Enter (n)
• What's your project's name?: Type any app name (e.g., "acap-dev") and press Enter
• In which directory is your code located? ./: Press Enter to select the ./ default
• Other info prompts:

  Local settings detected in vercel.json:
  No framework detected. Default Project Settings:
  ...
• Want to modify these settings? [y/N] n: Press Enter (n)

Take note of the projectId and orgId values from the project.json file inside the generated .vercel folder.

VERCEL_TOKEN=(Use the VERCEL_TOKEN value from step #1)
VERCEL_ORG_ID=(value of orgId)
VERCEL_PROJECT_ID_DEV=(value of projectId)
VERCEL_APP_DEV=(name of the "DEVELOPMENT" Vercel app)

Confirm the creation of an empty Vercel app with the project name from the prompt in the Vercel account's projects dashboard.

Go to (Vercel Project) -> Settings -> Environment Variables. Set the environment variables similar to the "DEVELOPMENT" Render Environment Variables.

Set the development Vercel app's Runtime to Node 16.x.

• Go to the (Vercel Project) -> Settings -> General -> Node.js Version section.
• Set the Node.js Version to 16.x

Prepare the local ACAP server directory for Vercel deployment. Confirm that the acap-v2/server directory has the following files:

• Create a .vercelignore file to exclude unnecessary items from being deployed to Vercel.
  • Copy the contents of the .gitignore file into the .vercelignore file.
  • Include all other directories and files to omit in the Vercel deployment in the .vercelignore file.
• Make sure that your target project directory has an /api directory that:
  • contains Vercel serverless function files following the Vercel "api" syntax
  • Or an index.js file (for standalone Express apps), minus the app.listen() part, with the app exported as module.exports = app
• Create a vercel.json file in the /acap-v2/server directory. See the attached vercel.json file for reference.

  {
    "rewrites": [{
      "source": "/api/(.)",
      "destination": "/api"
    }],
    "redirects": [{
      "source": "/src(.)",
      "destination": "/index.html"
    }]
  }

Generate the API documentation for Vercel deployment.

npm run gen:docs:vercel

Deploy the "DEVELOPMENT" Vercel app locally for the first time from a terminal, using the "raw" value of the VERCEL_TOKEN variable from step #1.

vercel pull --yes --environment=production --token=VERCEL_TOKEN
vercel build --prod --token=VERCEL_TOKEN
vercel deploy --prebuilt --prod --token=VERCEL_TOKEN

Delete the acap-v2/server/.vercel directory generated after completing the ACAP Development App Initialization steps.

Login using the Vercel CLI if not yet signed in.

vercel login

Navigate to the acap-v2/server directory using a terminal. Run the vercel link command to create a new Vercel project - for the "PRODUCTION" environment.

vercel link

Answer the required prompts, similar to the ACAP Development App Initialization. Provide a different project name when prompted with the question:

• What's your project's name?: Type a new app name (e.g., "acap-prod") and press Enter

Take note of the new projectId and orgId values from the project.json file inside the newly generated .vercel folder.

VERCEL_PROJECT_ID_PROD=(value of new projectId)
VERCEL_APP_PROD=(name of the "PRODUCTION" Vercel app)

Confirm the creation of an empty Vercel app with the "PRODUCTION" project name created by the prompt in the Vercel account's projects dashboard.

Go to the PRODUCTION" (Vercel Project) -> Settings -> Environment Variables. Set the environment variables similar to the "PRODUCTION" Render Environment Variables.

Set the production Vercel app's Runtime to Node 16.x.

Generate the API documentation for Vercel deployment.

npm run gen:docs:vercel

Deploy the "PRODUCTION" Vercel app locally for the first time from the terminal. Use the "raw" value of the VERCEL_TOKEN variable from step #1.

vercel pull --yes --environment=production --token=VERCEL_TOKEN
vercel build --prod --token=VERCEL_TOKEN
vercel deploy --prebuilt --prod --token=VERCEL_TOKEN