Running Payblocks locally in under 5 minutes

Three terminal commands. Two environment variables. One full-stack site with 100+ blocks, role-based access, and a working admin panel.

Installation

Three commands to a running site

Clone, install, and start — then set your two required env vars.

Step 1 — Clone and install

  • git clone https://github.com/trieb-work/payblocks my-site

  • cd my-site && pnpm install

  • Use typed generation commands after schema changes.

Step 2 — Configure env

  • cp .env.example .env.local

  • Set MONGODB_URI, PAYLOAD_SECRET, NEXT_PUBLIC_SERVER_URL

  • Use typed generation commands after schema changes.

Step 3 — Start

  • pnpm dev — open http://localhost:3000/admin

  • Keep environment variables in sync for local and production.

  • Use typed generation commands after schema changes.

What is running after pnpm dev

A full-stack site with the Payload admin panel, Next.js frontend, 100+ blocks, and all the infrastructure wired together.

Payload Admin at /admin

Create your first user on first login. All collections and globals available.

Frontend at /

The catch-all route renders pages by slug from the database. Create a page in Payload, publish it — it appears on the frontend.

Admin API at /next/admin/cli

Set ADMIN_CLI_SECRET in .env.local. Full CRUD + schema introspection over all collections.

FAQ

Quickstart questions

Answers to common setup and implementation concerns.

Still have questions?

We're here to provide clarity and assist with any queries you may have.