Getting Started

Get Based running locally in under 5 minutes.

Prerequisites

  • Node.js 20+
  • pnpm 9+
  • Git

Clone & Install

git clone https://github.com/DecOperations/Based.git
cd Based
pnpm install

Configure Environment

Copy the example env and fill in your Privy credentials:

cp .env.example .env

For local development, set S3_MODE=local to use the filesystem bucket at .worm/data/.

Run

pnpm dev

Open http://localhost:3000 — you should see the Based dashboard with a sidebar and empty bases list.

Project Structure

Based/
├── apps/web/          # Next.js 15 app
├── packages/
│   └── tiptap-blocks/ # Shared Tiptap extensions
├── specs/             # Product specifications
├── .worm/
│   ├── schema.json    # Bucket path definitions
│   ├── config.json    # S3WORM config
│   └── data/          # Local filesystem bucket
├── turbo.json         # Turborepo config
└── pnpm-workspace.yaml