@greenwood/plugin-adapter-vercel

Overview

Enables usage of Vercel hosting for API routes and SSR pages. For more information and complete docs on Greenwood, please visit our website.

This package assumes you already have @greenwood/cli installed.

Features

In addition to publishing a project's static assets to the Vercel's CDN, this plugin adapts Greenwood Greenwood API routes and SSR pages into Vercel Serverless functions using their Build Output API.

Note: You can see a working example of this plugin here.

Installation

You can use your favorite JavaScript package manager to install this package.

# npm
$ npm i -D @greenwood/plugin-adapter-vercel

# yarn
$ yarn add @greenwood/plugin-adapter-vercel --dev

# pnpm
$ pnpm add -D @greenwood/plugin-adapter-vercel

You will then want to create a vercel.json file, customized to match your project. Assuming you have an npm script called build:

{
  "scripts": {
    "build": "greenwood build"
  }
}

This would be the minimum vercel.json configuration you would need:

{
  "buildCommand": "npm run build"
}

Usage

Add this plugin to your greenwood.config.js.

import { greenwoodPluginAdapterVercel } from '@greenwood/plugin-adapter-vercel';

export default {
  // ...

  plugins: [
    greenwoodPluginAdapterVercel()
  ]
}

Options

Runtime

Vercel supports multiple semver major NodeJS versions for the serverless runtime as part of the build output API. With the runtime option, you can configure your functions for any supported NodeJS version. Current default version is nodejs20.x.

import { greenwoodPluginAdapterVercel } from '@greenwood/plugin-adapter-vercel';

export default {
  plugins: [
    greenwoodPluginAdapterVercel({
      runtime: 'nodejs22.x'
    })
  ]
}

Caveats

1. Edge runtime is not supported (yet).
2. The Vercel CLI (vercel dev) is not compatible with Build Output v3.

   Error: Detected Build Output v3 from "npm run build", but it is not supported for `vercel dev`. Please set the Development Command in your Project Settings.