Documentation
README
Superset Project Setup
Goal: every new workspace (isolated git worktree) for this repo comes up ready — dependencies installed, env present, services reachable — without manual steps.
1. Inspect the repo
Work out what a fresh worktree needs, and ask about anything ambiguous:
- Package manager and install command (lockfiles decide: bun/pnpm/yarn/npm, cargo, uv, ...)
- Env files:
.envis usually gitignored, so new worktrees need it copied from the main checkout or generated from.env.example - Services (docker-compose, databases) and dev command + ports
- Monorepo layout (does setup need a
cwd?)
2. Author .superset/config.json
This file is what wires lifecycle scripts in — a bare setup.sh without config.json is NOT picked up. Schema:
This is the opening of the README. Read the full README on GitHub.