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.).
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, rundocker-compose down -vto reset the volumes and restart.
mvn clean install -DskipTests
# Service 1
mvn spring-boot:run -pl people-management-service
# Service 2
mvn spring-boot:run -pl tax-engine-service# Run all tests in the ecosystem
mvn testSee people-management-service/src/test/performance/README.md for k6 load testing instructions.
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
RestClientvsOpenFeign.
-
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).