Back to home

Quick Start

Get Atlas running locally in under 5 minutes. All you need is Docker, Node.js 20+, and pnpm.

Prerequisites

  • Docker Desktop (running)
  • Node.js ≥ 20.0.0
  • pnpm ≥ 9.0.0

1. Clone the repository

Get the Atlas source code on your machine.

bash
git clone https://github.com/orphiclabs/atlas.git
cd atlas

2. Install dependencies

Atlas uses pnpm workspaces for package management.

bash
pnpm install

3. Initialize infrastructure

This pulls Docker images and starts Caddy, Logto, and PostgreSQL.

bash
pnpm -w exec tsx apps/cli/src/index.ts init

4. Start the Manager API

The Manager API handles project lifecycle. Run it in a separate terminal.

bash
pnpm dev:manager

5. Create your first project

Spin up a PocketBase instance with a single command.

bash
pnpm -w exec tsx apps/cli/src/index.ts create my-first-app

6. Open the admin dashboard

Each project gets its own PocketBase admin UI for managing data, auth, and settings.

bash
pnpm -w exec tsx apps/cli/src/index.ts open my-first-app

7. Start the Dashboard (optional)

Launch the Atlas web dashboard for visual project management.

bash
pnpm dev:dashboard

What's next?

  • Connect your app: Use the PocketBase SDK (pocketbase npm package) to connect your frontend to the project's API.
  • Define your schema: Open the PocketBase admin UI to create collections, define fields, and set up auth rules.
  • Deploy to production: Copy the infra/ directory to your Hetzner VPS and use the production Caddyfile for auto-HTTPS.