> ## Documentation Index
> Fetch the complete documentation index at: https://docs.niceyup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Local development

> A guide on how to run Niceyup’s codebase locally.

## Get started

### Prerequisites

* Node.js >= 22
* pnpm >= 10.4.1
* Docker and Docker Compose (for local development)

### Installation

<Steps>
  <Step title="Clone the repository">
    ```bash theme={null}
    git clone https://github.com/niceyup/niceyup.git
    cd niceyup
    ```
  </Step>

  <Step title="Install dependencies">
    ```bash theme={null}
    pnpm install
    ```
  </Step>

  <Step title="Set up environment variables">
    ```bash theme={null}
    cp .env.example .env
    # Edit .env with your configuration
    ```
  </Step>

  <Step title="Start local services (PostgreSQL and Redis)">
    ```bash theme={null}
    docker-compose up -d
    ```
  </Step>

  <Step title="Run database migrations">
    ```bash theme={null}
    cd packages/db
    pnpm run db:push
    ```
  </Step>

  <Step title="Start the development servers">
    ```bash theme={null}
    pnpm dev
    ```

    This will start:

    * Web app at `http://localhost:3000`
    * API server at `http://localhost:3333`
  </Step>
</Steps>