Requirements

In this section, we outline the key functional requirements, non-functional requirements, and out-of-scope features for the Colearn platform.

Functional Requirements

ID	Requirement	Description	Priority	Scope
F1	Authentication	User should be able to login/signup using email and password.	High	Current
F2	Project Creation	User should be able to create a project specifying the project description.	High	Current
F3	Project Discovery	User should be able to view project details.	High	Current
F4	Project Joining	User should be able to apply for a project. Project owner should be able to view applicants and accept/reject them. Accepted users should be able to join project team.	High	Current
F5	Project Dashboard	A Dedicated dashboard for accessing all the features.	High	Current
F6	Team Communication	Team members should be able to communicate via chat feature.	High	Future
F7	Task Management	Project Owner should be able to create and assign tasks. Deadlines for assigned tasks should be set and tracked and reminders sent.	Medium	Future
F8	Progress Tracking	Periodic progress updates should be logged and viewable by all team members.	Medium	Future
F9	Resouce Sharing	Team members should be able to share resources within the team.	Low	Future

Users sign up using email and password should verify their email address via a otp sent to their email.
JWT token based authentication and authorization will be implemented for secure access to the platform.

Users should be able to create new projects by providing necessary details such as project title, description, required skills, and location tags.
Project owners should be able to edit project details after creation.

Users should be able to see projects with skills, title, and location tags.
Users should be able to view detailed information about each project, including project description, requirements, and team members.

Users should be able to apply for projects they are interested in with a note explaining their interest and relevant skills.
Project owners should be able to view a list of applicants for their projects, along with their application notes.
Project owners should be able to accept or reject applicants. Accepted users should receive a email notification and be able to access the project dashboard.

A dedicated project dashboard should be available for each project, accessible only to project team members.
The dashboard should provide role based access to all project-related features, including communication, task management, progress tracking, and resource sharing.

Team members should be able to send and receive messages in real-time using a chat feature on a common forum.

Project owners should be able to create tasks, assign them to team members, and set deadlines.
Team members should receive reminders through email for upcoming deadlines and be able to mark tasks as complete.

System should generate periodic progress based on task creation and completion data.
Progress updates should be viewable by all team members on the project dashboard.

Team members should be able to upload and share documents, links, and other resources within the project team on a dedicated resource sharing section.

ID	Requirement	Description	Priority	Scope
NF1	Code Readability	Code should clean and modular.	High	Current
NF2	Reliability	All the request should be processed within miliseconds.	High	Current
NF3	Security	All the passwords should be encrypted.	High	Current
NF4	Scalability	Seperate microservices for email, schedular and chat services	Medium	Future