Skip to content
FRAME / docs

Search is only available in production builds. Try building and previewing the site to test it out locally.

Quickstart

This guide helps you run the @frame/next application in your local environment.

Prerequisites

Section titled “Prerequisites”

Make sure you have the following installed before you start:

  • Node.js (version 24.18.0 or later)
  • pnpm (primary package manager for the monorepo)
  • A running PostgreSQL database

Local environment setup

Section titled “Local environment setup”

Follow these steps to start the development server:

    1. Install dependencies

    From the monorepo root, install all required dependencies with pnpm:

    Terminal window
    pnpm install

    1. Configure environment variables

      Copy the example file to configure your credentials, secrets, and local URLs:

      Terminal window
      cp apps/next/.env.example apps/next/.env

    2. Sync the database

      Run the migrations needed to prepare your schema using Drizzle ORM:

      Terminal window
      pnpm -F @frame/models db:push

    3. Start the development server

      Start the Next.js application in development mode. By default, the server is available at http://localhost:3000.

      bash pnpm -F next dev