How rashidinvincible/mini-expense-manager works
Project Type and Purpose
• This is a backend microservice (Spring Boot) for a “Mini Expense Manager.”
• Purpose: expose REST endpoints to create/list expenses, flag anomalies, bulk‐upload via CSV, and produce dashboard summaries.
• Technology stack: Java 17, Spring Boot, Spring Data JPA, PostgreSQL, Lombok, Maven.
File Structure
• Standard Maven layout with pom.xml and src/main/java/com/example/expensemanager.
• Layered packages:
• controller (ExpenseController)
• service (ExpenseService)
• repository (ExpenseRepository)
• model (Expense, DashboardSummary, etc.)
• Config in src/main/resources/application.properties pointing to PostgreSQL.
• Test suite under src/test/java.
Key README Insights
• Endpoints:
• POST /api/expenses (manual entry)
• GET /api/expenses (list)
• GET /api/expenses/anomalies (flagged)
• POST /api/expenses/upload-csv (bulk CSV)
• Rule-based categorization and anomaly logic live in ExpenseService.
• No frontend in this repo.
Main Components
a. Client (Postman, future React UI)
b. API Layer (Spring Boot REST Controllers)
c. Business Layer (ExpenseService)
d. Persistence Layer (ExpenseRepository via Spring Data JPA)
e. Database (PostgreSQL)
f. CSV Processor (part of ExpenseService)
g. Hardcoded Category-Mapping Rules (within Service)
h. Dashboard Generator (Service-provided summary DTO)
Relationships and Data Flow
• Client → HTTP call → Controller
• Controller forwards DTOs to Service
• Service applies rules, invokes Repository
• Repository CRUD queries → PostgreSQL
• Service retrieves raw data → computes anomalies & dashboard DTOs → Controller → Client
• CSV upload path: Controller receives file → Service parses CSV → calls Repository in batch
Architectural Patterns & Design Principles
• Layered (Controller → Service → Repository → Database)
• Single Spring Boot application (monolith)
• Separation of concerns: REST, business logic, persistence
• DTO & Entity distinction: models vs summaries (DashboardSummary)
• Rule engine (hardcoded) encapsulated in service for future extension
Elements
• Clear labels: component names, endpoint URIs
• Sub‐component details: CSV Parser, Anomaly Detector, Dashboard Calculator