# documentations

## documentation 1
- there will be a scrum meeting every week discussing the progress of each team member and overall progress of the project
- every member will give there updates on tasks or issues they are assigned

### frameworks
- __express__ for backend api development
- __React.js__ for frontend UI
- __mongodb__ for database
- __figma__ for mockup design
- __git__ for version controlling
- __google meet__ for scrum , code review meetings
- __markdown or google sheet __ for documentations of code and process

### task assignments

`todo` : fill the table up with related tasks

| task name | tema member | PR dealline | review date|
| -------- | -------- | -------- | ---------|
| login / register api | jon | 20 march 2023 | 21 march 2023 |

## documentation 4
- each task will have its own branch
- the naming convension would be `task/<task-name>` example: task/admin-api , task/user-profile-frontend
- when a team member starts working on a task , he/she will create a new branch from the main branch with the naming convension , and will work on that branch
- when the work is done he/she will create a PR (Pull request) to the main branch
- the PR will be reviewed by the team lead , reviwing the code agains the coding convension
- ensure that necessary tests are written and they pass
- after PR review if there is any feedback or refactoring tobe done will be specified
- If the PR is ready to be merged , team lead will merge it
- if there is any issues faced while merging a new issue will be created on kanban board with description and necessary mentions

## documentation 6

## documentation 1

### requirments analysis

there are going to be three types of users in the system
1. admin
2. teachers
3. students

### teachers
- can login / register [must]
- will be able to create quizes [must]
- list all his create quizes [should]
- see the students who took the quizes and their scores [should]
- update own profile [could]

### students
- can login / register [must]
- see all the available quiz [should]
- take a quiz [must]
- list all the quizes taken by him/her [should]
- update own profile [could]

### admin
- can list all the users (teacher / student) [must]
- can enable or disable a user [must]
- read and update other users profile information [could]
- edit own profile [could]