Skip to content
Getting Started

Use Supabase with RedwoodJS

Learn how to create a Supabase project, add some sample data to your database using Prisma migration and seeds, and query the data from a RedwoodJS app.

AI Prompt
Help me add Supabase to my RedwoodJS project. Create a Supabase project at database.new and copy the Transaction and Session pooler connection strings. Then: 1. Run `yarn create redwood-app my-app --ts` to scaffold the app. 2. Set `DATABASE_URL` (Transaction pooler with `?pgbouncer=true`) and `DIRECT_URL` (Session pooler) in `.env`. 3. Update `api/db/schema.prisma` to use the PostgreSQL datasource with those env vars. 4. Add an `Instrument` model to the Prisma schema and run `yarn rw prisma migrate dev`. 5. Update `scripts/seed.ts` with instrument data and run `yarn rw prisma db seed`. 6. Run `yarn rw g scaffold instrument` to scaffold the CRUD UI. 7. Run `yarn rw dev` and open http://localhost:8910/instruments. REFERENCE https://supabase.com/docs/guides/getting-started/quickstarts/redwoodjs.md

1. Create a Supabase project#

To start, you need a Supabase project.

Create a new Supabase project from the Dashboard of any organization you belong to.

Save your database password securely. You need it for the connection string.

2. Gather database connection strings#

Open the project Connect panel. This quickstart connects using the Transaction pooler and Session pooler mode. Transaction mode is used for application queries and Session mode is used for running migrations with Prisma.

To do this, set the connection mode to Transaction in the Database Settings page and copy the connection string and append ?pgbouncer=true&connection_limit=1. pgbouncer=true disables Prisma from generating prepared statements. This is required since our connection pooler does not support prepared statements in transaction mode yet. The connection_limit=1 parameter is only required if you are using Prisma from a serverless environment. This is the Transaction mode connection string.

To get the Session mode connection pooler string, change the port of the connection string from the dashboard to 5432.

You will need the Transaction mode connection string and the Session mode connection string to set up environment variables in Step 6.

3. Create a RedwoodJS app#

Create a RedwoodJS app with TypeScript.

1
yarn create redwood-app my-app --ts

4. Install Supabase's Agent Skills (optional)#

Supabase's Agent Skills is a curated set of instructions that give your AI agent procedural knowledge about working with Supabase.

Install them so your AI coding agent can produce more accurate, reliable code using current Supabase patterns, such as authentication, server-side rendering, and database migrations, rather than relying solely on training data.

To install, run the following command in the root of your project:

1
npx skills add supabase/agent-skills

5. Install MCP server (optional)#

The Supabase MCP server connects AI assistants to Supabase, allowing you to interact with your projects on your behalf. Find out more on how to add it to your client in the MCP docs.

6. Configure environment variables#

In your .env file, add the following environment variables for your database connection:

  • The DATABASE_URL should use the Transaction mode connection string you copied in Step 2.

  • The DIRECT_URL should use the Session mode connection string you copied in Step 2.

.env
1
# Transaction mode connection string — used by Prisma Client for app queries
2
DATABASE_URL="postgres://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@aws-[REGION].pooler.supabase.com:6543/postgres?pgbouncer=true&connection_limit=1"
3
4
# Session mode connection string — used by Prisma Migrate
5
DIRECT_URL="postgres://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@aws-[REGION].pooler.supabase.com:5432/postgres"

7. Update your Prisma schema#

By default, RedwoodJS ships with a SQLite database, but we want to use Postgres.

Update your Prisma schema file api/db/schema.prisma to use your Supabase Postgres database connection environment variables you set up in Step 6.

api/db/schema.prisma
1
datasource db {
2
  provider  = "postgresql"
3
  url       = env("DATABASE_URL")
4
  directUrl = env("DIRECT_URL")
5
}

8. Create the instrument model and apply a schema migration#

Create the Instrument model in api/db/schema.prisma and then run yarn rw prisma migrate dev from your terminal to apply the migration.

api/db/schema.prisma
1
model Instrument {
2
  id   Int    @id @default(autoincrement())
3
  name String @unique
4
}

9. Update seed script#

Seed the database with a few instruments.

Update the file scripts/seed.ts to contain the following code:

scripts/seed.ts
1
import type { Prisma } from '@prisma/client'
2
import { db } from 'api/src/lib/db'
3
4
export default async () => {
5
  try {
6
    const data: Prisma.InstrumentCreateArgs['data'][] = [
7
      { name: 'dulcimer' },
8
      { name: 'harp' },
9
      { name: 'guitar' },
10
    ]
11
12
    console.log('Seeding instruments ...')
13
14
    const instruments = await db.instrument.createMany({ data })
15
16
    console.log('Done.', instruments)
17
  } catch (error) {
18
    console.error(error)
19
  }
20
}

10. Seed your database#

Run the seed database command to populate the Instrument table with the instruments you created.

1
yarn rw prisma db seed

11. Scaffold the instrument UI#

Use RedwoodJS generators to scaffold a CRUD UI for the Instrument model.

1
yarn rw g scaffold instrument

12. Start the app#

Start the app via yarn rw dev. A browser will open to the RedwoodJS Splash page.

13. View instruments UI#

Click on /instruments to visit http://localhost:8910/instruments where should see the list of instruments.

You may now edit, delete, and add new instruments using the scaffolded UI.

Next steps#