Redwood JS & Vercel

The below instructions will guide you through setting up your RedwoodJS application and deploying it seamlessly on Vercel. Follow along to get your project up and running.

Basic install

1

Create instantiation file for Appear

Create a file where you can instantiate Appear, for example: api/src/withAppear.ts

/// withAppear.ts
import { createVercelMiddleware } from "@appear.sh/introspector/integrations/redwoodjs"

export const withAppear = createVercelMiddleware({
  // api key you can obtain at https://app.appear.sh/settings
  apiKey: "your-api-key",
  // any identifier of environment you prefer, we recommend separating production/staging/development. The more granular the better
  environment: process.env.NODE_ENV ?? "development",
  // other config as you desire
  // ...
})

2

Wrap your Serverless Functions

Wrap your Serverless Functions (API Endpoints) in withAppear

// eg. api/src/functions/<function name>/<function name>.ts
import { withAppear } from "src/withAppear"

export const handler = withAppear(async (event, context) => {
  // your code
})

If you have any queries or require support with the above instructions, please get in touch with us.