From d0d34fac37f8370d641642d7335e328ec5994a2c Mon Sep 17 00:00:00 2001 From: Jean Jacques Avril Date: Sun, 5 Jan 2025 10:09:41 +0000 Subject: [PATCH] docu: added spec and roadmap --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index f57b04f..f2210fe 100755 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ The current focus is backend development, while frontend development has been se ActaTempus adheres to **Domain-Driven Design (DDD)** and **Clean Architecture** principles. The system is divided into **four primary layers**: +![Architecture Diagram](docs/media/architecture.png) + 1️⃣ **Domain Layer**: - Contracts, definitions, and core logic. @@ -39,6 +41,13 @@ ActaTempus adheres to **Domain-Driven Design (DDD)** and **Clean Architecture** --- +## 📑 Specification + +The detailed system specification is available in the documentation. Refer to the specification document for an in-depth understanding of the system design, architecture, and implementation details. + +[📄 View the Specification](docs/KP_Spec-4.pdf) +--- + ## 🛠️ Technology Stack ### ⚙️ Backend @@ -202,6 +211,31 @@ The Insomnia collection is provided under `docs/insomnia`. Import it to get star --- +## 🛣️ Roadmap + +### Phase 1: **Initialize** +- ✅ Define specifications +- ✅ Set up repository + +### Phase 2: **Setup** +- ✅ Frontend (Next.js, Deno) +- ✅ Backends (Dart & Go) +- ✅ Devcontainer + +### Phase 3: **MVP Development** +- Build foundational backends in Go & Dart +- Implement: + - ✅ Domain layer (Entities, Repositories) + - ✅ Application logic (Services, DTOs, JWT Authentication) + - ✅ Basic authorization + +### Phase 4: **Web UI** +- 🎨 Build frontend for: + - Timetracking + - Project management + - Reporting + +--- ## 🌐 Resources