How arjunastrw/project-management-hub works
Project Type and Purpose
• This is a monolithic, full-stack backend service written in Go.
• Purpose: Provide RESTful APIs for project, task, report, and user management; handle authentication via JWT; persist data in a relational database and file storage; generate and expose reports; integrate with external productivity tools.
File Structure
• Top-level components (packages/directories):
• main.go / server.go: Application entrypoint and HTTP server.
• config: DB connection, raw SQL queries.
• delivery: HTTP layer (controllers, middleware).
• usecase: Business logic, orchestrates domain operations.
• repository: Data persistence (DB and file-based).
• model: Domain entities and DTOs.
• shared: Common utilities (JSON responses, JWT service, pagination models).
• report: Report generation logic and result storage.
• mock: Test doubles for unit tests.
• sql: DDL/DML scripts.
• Dockerfile / docker-compose.yml: Containerization.
README for Additional Insights
• Core features: task management, collaboration, resource allocation, progress tracking, document management, integrations.
• External integrations: Slack, Jira, Google Workspace (depicted as optional external services).
Main Components & Their Relationships
a. Clients & Entry Points
• Web/mobile UIs or API clients → send HTTP(S) requests.
• Entrypoint: docker-compose or main.go spins up HTTP server (delivery/server.go).
b. Delivery Layer
• HTTP Server
• Middleware (auth_middleware.go): validates JWT tokens, injects user context.
• Controllers (auth, user, project, task, report): parse requests, call UseCase layer, format responses.
c. UseCase Layer
• auth_usecase, user_usecase, project_usecase, task_usecase, report_usecase: implement business rules, coordinate domain operations.
d. Repository Layer
• project_repository, user_repository, task_repository, report_repository: CRUD operations.
• Underlying stores:
• SQL database (DDL/DML under sql/; configured in config/config.go).
• File storage for report artifacts (repository/file dir path).
e. Shared Services & Models
• JWT Service (shared/service/jwt_service.go)
• JSON response builder (shared/common/json_response.go)
• Shared data models (pagination_model, jwt_model, json_model).
f. Report Module
• report_function.go: composes data from UseCase + repository, writes report files under report/report-result.
g. External Integrations (optional)
• Slack, Jira, Google Workspace as “External Services” if invoked (not present in code, but noted in README).
Architectural Patterns & Design Principles
• Layered (Onion/Clean) Architecture:
• Delivery (UI/API) → UseCase (Domain) → Repository (Persistence)
• Separation of concerns: each package has a well-defined role.
• Dependency direction: outer layers depend on inner layers (controllers → usecases → repositories).
• Testability: mocks for middleware, repository, and usecase layers.