Appearance
Quickstart
This page summarizes the fastest local setup. For full detail see Local development.
Prerequisites
- Java 21
- Docker + Compose v2
- pnpm 12 (optional — for Next.js frontends)
1. Start infrastructure
sh
cd Directwerk
cp .env.example .env
# Set SPRING_DATASOURCE_PASSWORD, DIRECTWERK_PLATFORM_CLIENT_SECRET, DIRECTWERK_TENANT_CLIENT_SECRET
docker compose up -d2. Run the API
sh
./gradlew :directwerk-app:bootRun| URL | Purpose |
|---|---|
| http://localhost:8080/actuator/health | Health |
| http://localhost:8080/swagger-ui.html | OpenAPI UI |
| http://127.0.0.1:8025 | Mailpit inbox |
3. Seeded tenants
Local profile seeds alpha tenants:
alpha-a.localhost→ tenantalpha-show-aalpha-b.localhost→ tenantalpha-show-b
Add to /etc/hosts if needed:
text
127.0.0.1 alpha-a.localhost alpha-b.localhostDefault password: value of DIRECTWERK_DEV_SEED_PASSWORD in .env.
4. Optional frontends
From the repo root:
sh
pnpm install
cd directwerk-studio && pnpm dev # :3003
cd directwerk-web && pnpm dev # :3004Next
- Environment variables
- Subscriptions & entitlements — how paid content works
- API integration