Skip to content

wkspower/wks-platform

Repository files navigation

WKS Platform

License

WKS Platform is an open-source Case Management & Process Automation solution built on Spring Boot, React and Camunda.

📖 Documentation  ·  Contact  ·  Subscribe for updates

The Docker Compose stack in this repo is for local development only — it is not production-hardened.

Prerequisites

  • Docker Compose v2.20.0 or newer (check with docker compose version). The stack uses the required: field in depends_on, which older versions reject with Additional property required is not allowed. On Windows/macOS, update Docker Desktop; make sure you invoke docker compose (the v2 plugin) rather than the legacy docker-compose v1 command.

Quick start (full stack)

Brings up the full stack — backend, case portal, and a demo seed — with images pulled from the public GitHub Container Registry (no Maven/Yarn build required):

git clone https://github.com/wkspower/wks-platform.git
cd wks-platform
cp .env-sample .env
docker compose up -d

On first run the demo-data-loader bootstraps a Keycloak realm and a demo user and seeds sample cases. Wait for it to finish, then open http://localhost:3001 and log in with demo / demo.

Minimal stack (no auth, no authorization)

Runs just the case engine + portal — no Mongo, Keycloak, OPA, Camunda or MinIO. It uses an embedded H2 datastore and an in-process dev-token issuer, so the portal logs you in automatically (no credentials), authorization is off, and there's no workflow engine. Built from source because the published images predate these toggles:

COMPOSE_PROFILES=app,portal \
WKS_SPRING_PROFILES=db-h2 WKS_AUTH_MODE=dev-token WKS_AUTHZ_OPA_ENABLED=false \
WKS_BPM_ENGINE=none WKS_TENANCY_MULTI_TENANT=false WKS_SEED_ENABLED=true \
REACT_APP_AUTH_MODE=dev-token REACT_APP_AUTH_ISSUER_URL=http://localhost:8081/dev-auth \
docker compose up -d --build

Then open http://localhost:3001 — you're logged in automatically.

Document upload works in this mode with no storage-api: set REACT_APP_STORAGE_MODE=inline and attachment bytes are stored base64 on the case document itself (small docs / demos — use minio or filesystem for production). See the Document Storage Modes docs.


For every other configuration — per-concern toggles, filesystem storage, notifications, Traefik, building from source, Camunda 8 — see the Installation docs.

License

WKS Platform is released under the MIT License.

Contact

Questions, feedback or contributions: hello@wkspower.com

About

WKS Platform is a cutting-edge Adaptive Case Management platform built on top of Camunda workflow automation engine. Designed to empower organizations with agile and flexible case management capabilities, WKS Platform enables efficient handling of complex, unstructured processes.

Resources

License

Code of conduct

Contributing

Security policy

Stars

49 stars

Watchers

4 watching

Forks

Packages

 
 
 

Contributors