How wkspower/wks-platform works
Project Type and Purpose
• WKS Platform is an open-source, full-stack solution focused on case management and process automation. It implements a multi-tenant architecture supporting industries such as financial services, healthcare, insurance, and more.
• It leverages a diverse set of technologies and frameworks including Spring Boot for the backend, React for the frontend, Camunda for BPM engine integration, MongoDB for data persistence, Keycloak for identity and access management, Traefik for routing, MinIO for object storage, OPA for policy enforcement, and Form.io for dynamic form creation.
High-Level Architectural Components
• Backend Services – Implemented in Java (Spring Boot) and split into various microservices (found under apps/java/services):
▪ Case Engine REST API which exposes functionality for case management, process instance handling, and record operations.
▪ External task processing services (both Camunda 7 and Camunda 8 versions) handling asynchronous tasks.
▪ Demo Data Loader service that seeds or configures data.
▪ Storage API service that interfaces with MinIO, DigitalOcean, and other object storage drivers.
• Core Libraries – Modular Java libraries (under apps/java/libraries) that include:
▪ API-Security, BPM Engine interfaces, client libraries (for Camunda and other BPM engines), and case engine business logic.
▪ These serve as the backbone for the domain logic and provide shared functionality across services.
• Middleware & External Integrations:
▪ Camunda BPM engines (Camunda 7 and Camunda 8) for process automation.
▪ MongoDB for data persistence.
▪ Keycloak for IAM and enforcing Zero Trust security principles.
▪ Traefik serving as the reverse proxy and load balancer.
▪ OPA (Open Policy Agent) for enforcing fine-grained security and business rules.
▪ Kafka integrations for external messaging (evident from the Kafka producer/consumer modules within the Java services).
▪ Form.io integration for creating dynamic forms.
• Node.js-based Services – Complementary Node apps provide additional functionalities such as:
▪ Email Sender, Novu Publisher, and Websocket Publisher for messaging and notifications.
Relationships and Interactions
▪ For frontend vs backend: Show React-based UIs communicating via REST (or WebSockets) to the backend APIs.
▪ Backend microservices communicate internally using domain libraries and interact with backend external systems (e.g., Camunda, MongoDB, Kafka, Keycloak, MinIO).
• Multi-tenancy aspects by including an abstraction layer (or a notation) around the core services to indicate tenant isolation.
Architectural Patterns, Design, and Key Technologies
• Microservices – The backend is divided into well-defined services, each responsible for a specific domain (case engine, external tasks, storage, etc.).
• Layered Architecture – The system is organized into presentation (React), business logic (Spring Boot services backed by shared libraries), and data layers (MongoDB).
• Integration Patterns – Use messaging patterns (show Kafka producers/consumers) and API gateways (via Traefik) to manage external and cross-service communications.
• Containerization & Deployment – With multiple Dockerfiles and docker-compose configurations, highlight that the entire system is containerized for orchestration and scalability.