Installation

How to get started with the project.

Follow these steps to get the project up and running.

Requirements

  • Node.js 22 or newer
  • A PostgreSQL database

Steps

  1. Clone the repository.
  2. Install dependencies:
Terminal
pnpm install
  1. Copy .env.example to .env and fill in the values:
.env
DATABASE_URI=postgres://user:password@localhost:5432/my_db
PAYLOAD_SECRET=a-long-random-secret
  1. Start the development environment:
Terminal
pnpm dev

That's it! Your local environment is now running at http://localhost:3000.

Database first

The development server needs PostgreSQL up before it starts. If the admin returns 500 but the public site loads, the database is almost certainly down.

Last updated on

Was this page helpful?

On this page