README.md

Postgres.js Example

An example using Postgres.js in a Next.js project.

Deploy your own

Once you have access to the environment variables you'll need, deploy the example using Vercel:

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-postgres with-postgres-app

yarn create next-app --example with-postgres with-postgres-app

pnpm create next-app --example with-postgres with-postgres-app

Configuration

Set up a Postgres database

Set up a Postgres database locally or use your favorite provider.

Configure environment variables

Copy the .env.local.example file in this directory to .env.local (this will be ignored by Git):

cp .env.local.example .env.local

Set the DATABASE_URL variable in .env.local to the connection uri of your postgres database.

Apply migrations

To setup up the migrations, use:

npm run migrate:up
# or
yarn migrate:up

Start Next.js in development mode

npm run dev
# or
yarn dev

Your app should now be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.

Deploy on Vercel

Deploy it to the cloud with Vercel (Documentation).