Skip to content
FRAME / docs

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

Quick Start Guide

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

Prerequisites

Section titled “Prerequisites”

Make sure your development environment has the following 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. Clone the repository (if you have not already) and navigate to the FRAME project root:
    Terminal window
    git clone https://github.com/pablousx/frame.git FRAME
    cd FRAME

    1. Install dependencies for the entire monorepo:

      Terminal window
      pnpm install

    2. Start the development server for the Astro application:

      Terminal window
      pnpm -F @frame/astro dev

      Note: This command runs the dev.ts script that orchestrates the local documentation environment. If you need to run Astro’s development server directly, you can also use pnpm -F @frame/astro dev:source.

Once it is running, open your browser and visit http://localhost:4321 to view the documentation live. Changes you make to local files appear instantly thanks to Hot Module Replacement (HMR).