Skip to main content

Run Apiome locally

Bring the local spine up with Docker and load the dev seed (the acme-corp tenant and the published petstore-sample project):

docker compose up --build --wait # postgres, migrate, seed, rest (:8000), mcp (:8765)
docker compose run --rm seed # idempotent; ensures the dev tenant + sample exist

Then sign in to the UI with the dev login ada@example.com / apiome-dev and open Control Panel → Dashboard. The default service ports are:

ServiceURL
REST APIhttp://localhost:8000 (interactive docs at /docs)
MCP serverhttp://localhost:8765 (MCP endpoint at /mcp)
UIthe Next.js app (/ade/dashboard, /ade/studio)

Every how-to page shows the UI, REST, and (where applicable) CLI way to do the same thing, plus a short verify step.

Where next​

Sign in with ada@example.com / apiome-dev, then follow the Getting started pages in order — they walk the spine from import to a published, browsable spec. The project README and the Golden Path cover the same path from the repository side.