Skip to main content
Use local setup when you want to test self-hosting, verify provider credentials, or inspect the full Scopy product flow before deploying it.

​
Prerequisites

  • Node.js 20 or newer.
  • pnpm
  • Docker, if you want to use the included local PostgreSQL service.

​
Install dependencies

From the repository root:

​
Create environment files

The default local ports are:

​
Start PostgreSQL

For a lightweight local instance, start only the database from the included compose file and run the TypeScript services directly:

​
Prepare the database

Run the application migrations and initialize the worker schema:

​
Run Scopy

The root dev script starts the product workspaces through Turbo. The API development task starts both the HTTP API and the worker process. Open:
The web app talks to the API at http://localhost:3001 by default.

​
Full local Docker stack

docker-compose.local.yml also defines production-like API, worker, and web containers: Use the full stack when you want to test container behavior. Use db plus local TypeScript processes for faster iteration while configuring or debugging a local instance.