Deploying to Vercel in Astro - Mini Project: Build & Apply

Deploying an Astro Project to Vercel

📖 Scenario: You have created a simple Astro website and want to share it with the world by deploying it to Vercel, a popular hosting platform.This project will guide you step-by-step to prepare your Astro project and deploy it to Vercel.

🎯 Goal: By the end, you will have your Astro project deployed and live on Vercel, accessible via a public URL.

📋 What You'll Learn

Create a basic Astro project folder with a package.json file

Add a build script to package.json

Initialize a Git repository and commit the project

Deploy the project to Vercel using the Vercel CLI

💡 Why This Matters

🌍 Real World

Deploying websites quickly and easily to share with users worldwide is a common task for web developers and content creators.

💼 Career

Knowing how to deploy projects to platforms like Vercel is essential for front-end developers, full-stack developers, and anyone working with modern web frameworks.

1

Create package.json with project info

Create a package.json file with the exact content: {"name": "astro-vercel-demo", "version": "1.0.0", "scripts": {"build": "astro build"}}

Astro

# Create a file named package.json with the specified content

Hint

Use a JSON structure with name, version, and scripts keys exactly as shown.

2

Add Vercel configuration file

Create a vercel.json file with the exact content: {"builds": [{"src": "package.json", "use": "@vercel/static-build"}], "routes": [{"src": "/(.*)", "dest": "/index.html"}]}

Astro

{
  "name": "astro-vercel-demo",
  "version": "1.0.0",
  "scripts": {
    "build": "astro build"
  }
}

# Create vercel.json with the specified build and routes configuration

Hint

This file tells Vercel how to build and serve your Astro project.

3

Initialize Git repository and commit files

Run the exact commands: git init, git add ., and git commit -m "Initial commit for Vercel deployment" in your project folder

Astro

{
  "name": "astro-vercel-demo",
  "version": "1.0.0",
  "scripts": {
    "build": "astro build"
  }
}

{
  "builds": [
    {"src": "package.json", "use": "@vercel/static-build"}
  ],
  "routes": [
    {"src": "/(.*)", "dest": "/index.html"}
  ]
}

# Run git init, git add ., and git commit -m "Initial commit for Vercel deployment"

Hint

These commands prepare your project for deployment by tracking files with Git.

4

Deploy project to Vercel using CLI

Run the exact command vercel --prod in your project folder to deploy your Astro site to Vercel

Astro

{
  "name": "astro-vercel-demo",
  "version": "1.0.0",
  "scripts": {
    "build": "astro build"
  }
}

{
  "builds": [
    {"src": "package.json", "use": "@vercel/static-build"}
  ],
  "routes": [
    {"src": "/(.*)", "dest": "/index.html"}
  ]
}

# Commands to run in terminal:
git init
git add .
git commit -m "Initial commit for Vercel deployment"

# Run vercel --prod to deploy your site

Hint

This command uploads your project to Vercel and makes it live.

Practice

1. What is the main benefit of deploying an Astro site to Vercel?

easy

A. It makes your site live on the internet quickly.

B. It requires manual server setup and configuration.

C. It disables automatic SSL certificates.

D. It only works with static HTML files.

Solution

1. Step 1: Understand Vercel's purpose

   Vercel is a platform that hosts websites and makes them accessible online quickly.

2. Step 2: Identify the main benefit for Astro sites

   Deploying to Vercel allows your Astro site to be live on the internet fast without manual server setup.

3. Final Answer:

   It makes your site live on the internet quickly. -> Option A

4. Quick Check:

   Deploying to Vercel = Quick live site [OK]

Hint: Remember: Vercel makes sites live fast and easy [OK]

Common Mistakes:

• Thinking Vercel requires manual server setup
• Believing SSL is disabled by default
• Assuming Vercel only supports static HTML

2. Which file should you include in your Astro project to configure Vercel deployment settings?

easy

A. package-lock.json

B. astro.config.js

C. vercel.json

D. index.html

Solution

1. Step 1: Identify Vercel configuration file

   Vercel uses a special file named vercel.json to customize deployment settings.

2. Step 2: Differentiate from other files

   astro.config.js configures Astro itself, package-lock.json manages dependencies, and index.html is a page file.

3. Final Answer:

   vercel.json -> Option C

4. Quick Check:

   Vercel config file = vercel.json [OK]

Hint: Vercel config always uses vercel.json file [OK]

Common Mistakes:

• Confusing Astro config with Vercel config
• Using package-lock.json for deployment settings
• Thinking index.html controls deployment

3. Given this vercel.json snippet:

{
  "builds": [{ "src": "package.json", "use": "@vercel/node" }],
  "routes": [{ "src": "/api/(.*)", "dest": "/api/index.js" }]
}

What does this configuration do when deployed?

medium

A. It builds a Node.js serverless function from package.json and routes API calls to /api/index.js.

B. It serves static files only and ignores API routes.

C. It causes a deployment error due to invalid JSON syntax.

D. It disables all API routes and only serves the homepage.

Solution

1. Step 1: Analyze the builds section

   The build uses @vercel/node with package.json, indicating a Node.js serverless function build.

2. Step 2: Analyze the routes section

   Routes matching /api/(.*) are sent to /api/index.js, directing API calls properly.

3. Final Answer:

   It builds a Node.js serverless function from package.json and routes API calls to /api/index.js. -> Option A

4. Quick Check:

   Build + API routing = Node.js serverless function [OK]

Hint: Look for builds and routes keys to understand deployment behavior [OK]

Common Mistakes:

• Assuming static files only without API support
• Thinking JSON syntax is invalid here
• Believing API routes are disabled

4. You deployed your Astro site to Vercel but get a 404 error on all pages. What is the most likely cause?

medium

A. You used an unsupported Node.js version in your project.

B. You forgot to set the build command in Vercel settings.

C. You did not connect your Git repository to Vercel.

D. Your vercel.json file has a syntax error.

Solution

1. Step 1: Understand 404 error cause on Vercel

   A 404 on all pages usually means Vercel did not build the site correctly or serve the pages.

2. Step 2: Check build command setting

   If the build command is missing, Vercel cannot build the site, causing 404 errors.

3. Final Answer:

   You forgot to set the build command in Vercel settings. -> Option B

4. Quick Check:

   Missing build command = 404 error [OK]

Hint: Always set build command in Vercel for Astro projects [OK]

Common Mistakes:

• Assuming syntax error causes 404 instead of build failure
• Thinking Git connection alone fixes 404
• Blaming Node.js version without checking build

5. You want to deploy an Astro site with server-side rendering (SSR) on Vercel. Which step is essential to ensure SSR works correctly?

hard

A. Disable all API routes in vercel.json.

B. Only deploy static files without any server code.

C. Use a custom domain without connecting Git repository.

D. Set the output property to server in astro.config.mjs and use a compatible adapter.

Solution

1. Step 1: Understand SSR requirement in Astro

   SSR requires Astro to output server code, not just static files.

2. Step 2: Configure Astro for SSR deployment

   Setting output: 'server' in astro.config.mjs and using a Vercel adapter enables SSR.

3. Final Answer:

   Set the output property to server in astro.config.mjs and use a compatible adapter. -> Option D

4. Quick Check:

   SSR needs server output and adapter [OK]

Hint: SSR needs output: 'server' and adapter in config [OK]

Common Mistakes:

• Deploying only static files for SSR
• Disabling API routes unnecessarily
• Ignoring Git connection for deployment