open-dpp Documentation

Local development ​

1) Install dependencies ​

bash
pnpm install

2) Configure environment ​

Create your local environment file:

bash
cp .env.dev.example .env.dev

Then update secrets and tokens in .env.dev.

The OAuth Provider is off by default. To try it against a local Trusted Client, uncomment the OPEN_DPP_OAUTH_PROVIDER_* block in .env.dev (an http://localhost:… redirect URI is accepted on loopback hosts); the backend then serves the issuer at <OPEN_DPP_URL>/api/v2/auth. See the Production setup guide for the contract. Two maintainer notes: apps/main declares @better-auth/core explicitly next to the better-auth plugins, and the family is bumped together, because a plugin's unpinned core peer resolves to the newest release and splits the core graph; the plugin's mandatory consentPage option points at a route that never renders, since the Trusted Client skips consent.

3) Generate MongoDB key file ​

bash
openssl rand -base64 756 > docker/mongo_keyfile
chmod 0400 docker/mongo_keyfile

4) Start local infrastructure ​

Use the project helper:

bash
make dev

This starts required services from docker-compose.dev.yml (MongoDB, RustFS as S3-compatible object storage, and Mailpit). The rustfs-init container creates the two buckets from .env.dev with object versioning enabled and exits. Virus scanning of uploads is disabled in development; see the Production setup guide to enable it.

5) Start the application ​

bash
pnpm run dev

After startup:

6) Run the end-to-end tests ​

The Playwright suite in apps/e2e drives a real browser against a running app, so keep the infrastructure from step 4 and the app from step 5 up. It reads verification and revoke mails from Mailpit, and signs its own users up, so the instance needs OPEN_DPP_INSTANCE_SIGNUP_ENABLED and OPEN_DPP_INSTANCE_ORGANIZATION_CREATION_ENABLED set to "true" in .env.dev.

bash
pnpm run test:e2e      # headless
pnpm run test:e2e:ui   # interactive Playwright UI

To run a single project or spec, go through Playwright directly:

bash
pnpm run test:e2e -- --project=account

CI runs the setup, chromium and account projects on every pull request (.github/workflows/e2e.yml); firefox and webkit are local-only.