README.md

📚 Project Documentation

To maintain a clean and professional structure, all deep-dive documentation has been centralized in the /docs directory:

• System Architecture: High-level design and monorepo structure.
• Deployment & Environments: How to run the app in Local, Docker, and Cloud.
• Tax Engine Standards: Logical breakdown of Indian Tax laws and our Strategy implementation.
• Quality Standards: Guide to Checkstyle, PMD, and SpotBugs integration.
• API Test Plan: Manual verification steps and Postman payloads.
• Java 21 Migration Guide: Technical checklist of features migrated (Records, Switch Expressions, etc.).

---

🚀 Quick Start

Running with Docker (Full Stack)

cd docker
docker-compose up -d --build

• Tax Engine Service: http://localhost:8081

Note: If you face database errors like database "peopledb" does not exist, run docker-compose down -v to reset the volumes and restart.

Running Locally (Individual Services)

mvn clean install -DskipTests
# Service 1
mvn spring-boot:run -pl people-management-service
# Service 2
mvn spring-boot:run -pl tax-engine-service

🧪 Testing

Automated Tests

# Run all tests in the ecosystem
mvn test

Performance Benchmarks

See people-management-service/src/test/performance/README.md for k6 load testing instructions.

---

🛠️ Roadmap & TODO

Current Phase: Phase 2 - Intelligent Orchestration (Completed ✅)

• Tax Engine Roadmap

  • Robustness & Testing: Implement negative cases, edge cases, and stress tests.
  • Expanded Tax Rules: Implement Sections 80C, 80D, 24b and Surcharges.
  • Regime Optimization: Endpoint to suggest optimal regime (Old vs New).
  • Internal Research: Explore RestClient vs OpenFeign.

• Observability & Ops

  • Add Spring Boot Actuator to all services.
  • Standardize structured logging and Correlation IDs.

• Infrastructure

  • GitHub Actions CI/CD Pipeline integration.
  • Static Code Analysis Setup (SpotBugs, PMD, Checkstyle).
  • Multi-DB support (PostgreSQL/MySQL toggle).

Resources

• Java 17 Language Updates
• Spring Boot 3 Migration Guide