-
Notifications
You must be signed in to change notification settings - Fork 0
Requirements
sree edited this page May 11, 2025
·
3 revisions
This document captures the core functional and non-functional requirements for the TaskHub application, structured to support OOAD-based analysis and implementation.
| FR ID | Requirement Description | Linked Use Case(s) | Status |
|---|---|---|---|
| TH-FR-001 | The system shall allow users to register using email and password. | TH-UC-001 | Not Started |
| TH-FR-002 | The system shall allow users to log in and receive a JWT token. | TH-UC-002 | Not Started |
| TH-FR-003 | The system shall allow users to create notes with a title, content, and optional color. | TH-UC-003 | Not Started |
| TH-FR-004 | The system shall allow users to edit existing notes. | TH-UC-004 | Not Started |
| TH-FR-005 | The system shall allow users to delete their own notes. | TH-UC-005 | Not Started |
| TH-FR-006 | The system shall allow users to archive or unarchive a note. | TH-UC-006 | Not Started |
| TH-FR-007 | The system shall allow users to pin or unpin a note. | TH-UC-007 | Not Started |
| TH-FR-008 | The system shall allow users to create new labels. | TH-UC-008 | Not Started |
| TH-FR-009 | The system shall allow users to assign one or more labels to a note. | TH-UC-009 | Not Started |
| TH-FR-010 | The system shall allow users to filter and view notes by label. | TH-UC-010 | Not Started |
| NFR ID | Requirement Description | Category | Status |
|---|---|---|---|
| TH-NFR-001 | The system must be deployed as a set of containerized microservices using Docker. | Deployment | Not Started |
| TH-NFR-002 | The system must be bootstrappable via a single command (docker-compose up --build) without any manual prompts. |
DevOps | Not Started |
| TH-NFR-003 | The system must automatically run backend and frontend test suites as part of the bootstrapping process. | Quality Assurance | Not Started |
| TH-NFR-004 | Each microservice must be independently testable and deployable. | Maintainability | Not Started |
| TH-NFR-005 | The system must expose logs and health checks to support service monitoring and debugging. | Observability | Not Started |
| TH-NFR-006 | All APIs must be secured using JWT-based authentication. | Security | Not Started |
| TH-NFR-007 | The system must be deployable via GitHub Actions with CI workflows that run tests before pushing to production. | CI/CD | Not Started |
| TH-NFR-008 | The system must support horizontal scalability through stateless service design and load-balanced routing via NGINX. | Scalability | Not Started |
| TH-NFR-009 | The system must maintain response latency under 300ms for 95% of typical operations under normal load. | Performance | Not Started |
- NFRs are subject to refinement as architecture design evolves.
- Status values will be updated as we implement or validate each requirement.
- Requirements are version-controlled in this document and traceable to specific Git commits and use cases.