Getting Started
Visit superserve.ai or jump straight into the docs.
Structure
apps/
console/ # Sandbox dashboard (Next.js 16, App Router)
ui-docs/ # UI component docs (Vite)
packages/
cli/ # TypeScript CLI (@superserve/cli)
python-sdk/ # Python SDK (superserve on PyPI)
sdk/ # TypeScript SDK (@superserve/sdk)
ui/ # Shared UI components (@superserve/ui)
typescript-config/ # Shared tsconfig presets
tailwind-config/ # Shared Tailwind config
docs/ # Mintlify documentation site
tests/ # SDK end-to-end tests
Monorepo managed with Bun workspaces, Turborepo, and uv workspaces.
Setup
bun install # install all JS/TS dependencies
uv sync # install all Python dependencies
Development
bun run dev # start all dev servers
bun run build # build all packages
bun run lint # lint all packages
bun run format # format all files
bun run typecheck # type check all packages
bun run test # unit/integration tests
For more (per-package targets, dependency management, etc.), see CONTRIBUTING.md.
SDKs
- TypeScript:
@superserve/sdk—bun add @superserve/sdk - Python:
superserve—uv add superserve
Full reference at docs.superserve.ai.
Testing
bun run test # unit tests (no credentials)
SUPERSERVE_API_KEY=ss_live_... bun run test:e2e # e2e against staging
For environment overrides and single-language runs, see CONTRIBUTING.md.
Releasing
See RELEASING.md for publishing the SDKs to npm and PyPI.
Contributing
Contributions welcome — see CONTRIBUTING.md for guidelines.
License
Apache License 2.0 — see LICENSE.