Releases: AlphaSudo/promethus
Releases · AlphaSudo/promethus
Prometheus v1.0.0
Overview
Project Prometheus is a banking platform prototype built to demonstrate a modern, production-style architecture:
- Hexagonal (Ports & Adapters) architecture
- Event-sourced ledger with CQRS read models
- Kubernetes-first developer workflow (K3s/k3d + Tilt)
- Strong focus on observability and security patterns
This v1.0.0 release publishes the first stable, documented version of the codebase.
Highlights
-
Clean developer onboarding
- New, concise root
README.mdfocused on:- Quickstart (WSL2 K3s + Tilt, and k3d option)
- Tech stack
- Project structure
- Development workflow and endpoints
- Clear separation between:
README.md→ “how to use / run it”docs/ARCHITECTURE.md→ “why we designed it this way”
- New, concise root
-
Backend
- Java 21 + Spring Boot 3.x, Virtual Threads-based service
- Event-sourced account/ledger model backed by PostgreSQL
- Redis-based read model and caching
- Kafka-based event streaming integration
-
Infrastructure
- K3s / k3d manifests under
k8s/andinfrastructure/ - Linkerd service mesh, nginx-ingress, and Grafana Alloy for unified metrics/logs/traces
- Tilt configuration for local iterative development
- K3s / k3d manifests under
-
Frontend
- React + TypeScript dashboard (Vite)
- Configurable via
dashboard/.env(based ondashboard/.env.example)
-
Security & Compliance Patterns
- Keycloak-based authentication and JWT validation
- Layered security model (edge, ingress, service, data, secrets)
- Documentation of step-up authentication and secure service-to-service communication
Breaking / Security Notes
- Secrets cleanup: historical commits previously contained a
dashboard/.envfile with a real client secret.- The file is now removed from the repo and replaced with
dashboard/.env.example. .envfiles are ignored by.gitignore.- If you ever used the original secret in any environment, rotate that secret before using this code in any public or shared environment.
- The file is now removed from the repo and replaced with
How to Run (Summary)
See the root README.md for full details. Short version:
Connect Windows to K3s in WSL2 (recommended on Windows)
.\scripts\k3s-connect.ps1
Start backend
tilt up --stream=true
Start dashboard
cd dashboard
Copy-Item .env.example .env
npm install
npm run dev