How parthnagdev/efforttracker works
Project type and purpose
• This is a full-stack web application called “EffortTracker”:
• Frontend: React + TypeScript single-page application (SPA).
• Backend: Java Spring Boot REST API.
• OpenAPI specs for API contract and autogenerated TS client.
• Purpose: allow users to create, assign, estimate, track, filter tasks and generate reports.
File structure
• Top-level:
• backend/ — Spring Boot service:
– build.gradle, Dockerfile, gradlew scripts
– src/main/java: MVC layers (config, controller, filter, storage, tracker)
– application.properties
• frontend/ — React SPA:
– package.json, Tailwind CSS config, OpenAPI client generation setup
– public/: static assets and index.html
– src/: API client (src/api), components (forms, tables, navbar), pages, routes
• openapi/ — YAML spec and collection.json for API definition
• Deployment files:
• frontend/.github/workflows/ci-cd.yml for CI/CD
• backend/Dockerfile + AWS ECR/ECS/EKS deployment steps in README
README for additional insights
• Functional requirements: CRUD on tasks & users, task hierarchies, filtering, reporting.
• Deployment:
• Frontend → AWS Amplify (static-hosting).
• Backend → Docker → AWS ECR → EC2 container.
Main components
a. Client Layer:
– Browser (SPA UI)
– React Router, Redux or context (if used)
b. Presentation Layer:
– AWS Amplify hosting → serves static React assets
c. API Layer:
– Spring Boot REST controllers (EffortTrackingController, ProjectController, UserController)
– OpenAPI spec enforcement
d. Business Logic Layer:
– EffortTracker service classes
e. Data Access Layer:
– DbClient (storage), DatabaseConfig (JDBC/DataSource)
– Underlying relational database (e.g., Amazon RDS)
f. External Services:
– AWS Amplify, AWS ECR, AWS EC2
– (Optional) Authentication provider if used (e.g., Cognito)
g. DevOps/CI:
– GitHub Actions for frontend CI/CD
– Gradle build tasks, Docker builds for backend
Relationships and interactions
• User’s browser issues HTTP(S) requests to the React app; app invokes REST API:
Browser → (HTTPS) → Amplify-hosted React → (HTTPS/JSON) → Spring Boot API
• Spring Boot service handles requests via Controllers → calls EffortTracker logic → DbClient
→ relational DB → returns data → Controllers → JSON response → React UI
• OpenAPI spec governs request/response schemas; API client in frontend generated from it.
• CI/CD: pushes to GitHub → workflows build & deploy frontend to Amplify; backend built via Gradle → Docker image → pushed to ECR → pulled by EC2 instance.
Architectural patterns and design principles
• 3-tier architecture (Presentation / Application / Data)
• MVC pattern in Spring Boot (Controller → Service → Repository)
• Separation of concerns:
• CORS filter isolated in filter package
• Configuration in config package
• API client code autogenerated under frontend/src/api
• Stateless REST API for horizontal scalability