# Run BisQue locally

> Start the supported BisQue development environment and find its local services.

The supported development workflow runs the BisQue API, workers, and frontend from the checkout.
PostgreSQL runs in Docker, while the workflow execution slice uses the project's pinned local
Kubernetes environment.

## Prerequisites

Install Nix with flakes, Docker, direnv, and Just. Then run these commands from the `backend`
directory:

```bash
direnv allow
just setup
just dev
```

Open the URL printed by `just dev`. The default local account is:

```text
Username: admin
Password: bisque
```

These credentials are for the local development composition only.

## Check the environment

```bash
just dev-status
just urls
```

The API normally listens at `http://localhost:8000`. Its primary operational endpoints are:

* `/health/live` — process liveness;
* `/health/ready` — dependency readiness;
* `/api/docs` — interactive API documentation; and
* `/api/v1/openapi.json` — the OpenAPI contract.

## Enable optional tools

Options compose with the standard development command:

```bash
just dev --authentik --mailpit --observe
```

Use `--authentik` for the local OpenID Connect provider, `--mailpit` for email and password-reset
testing, and `--observe` for local logs and dashboards.

For architecture and dependency boundaries, read the maintainer
[architecture guide](https://github.com/connor11son/bisque-zero/blob/main/docs/architecture.md). The repository's `README.md` remains the complete
command reference.