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

# Quickstart

> Run the Atelier monorepo locally.

## Prerequisites

* **Node.js** and **pnpm** (the repo uses pnpm exclusively — never `npm` or `yarn` at the root)
* **Docker** for the local PostgreSQL instance

## Install

```bash theme={null}
pnpm install
```

## Start the database

A local Postgres runs via Docker Compose on port `5433`:

```bash theme={null}
docker compose up -d
```

Then apply migrations from `apps/server`:

```bash theme={null}
cd apps/server
pnpm db:migrate
```

## Run the apps

```bash theme={null}
# All apps in parallel
pnpm dev

# Or individually
pnpm web      # Vite dev server on port 5173
pnpm server   # Express via tsx watch
```

## Checks before pushing

<CodeGroup>
  ```bash web theme={null}
  pnpm --filter web typecheck
  pnpm --filter web lint
  ```

  ```bash server theme={null}
  cd apps/server && pnpm exec tsc --noEmit
  cd apps/server && pnpm test
  ```
</CodeGroup>

<Note>
  Railway runs `npx tsc` during deploy, so type errors that only show up in the
  IDE will still fail the build. Always run the server typecheck before pushing.
</Note>