pannabel/SkyLearn-Test
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
papi 2024-02-06 22:19:09 +03:00
parent 1dc8b68bf1
commit 00a3664e49
1 changed files with 43 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
README.md
View File

@ -6,39 +6,39 @@ Let's enhance the project by contributing! 👩‍💻👩‍💻
![Screenshot from 2023-12-31 17-36-31](https://github.com/adilmohak/django-lms/assets/60693922/e7fb628a-6275-4160-ae0f-ab27099ab3ca)
Current features
----------------
* Dashboard: School demographics and analytics. Restricted to only admins
* News And Events: All users can access this page
* Admin manages students(Add, Update, Delete)
* Admin manages lecturers(Add, Update, Delete)
* Students can Add and Drop courses
* Lecturers submit students' scores: _Attendance, Mid exam, Final exam, assignment_
* The system calculates students' _Total, average, point, and grades automatically_
* Grade comment for each student with a **pass**, **fail**, or **pass with a warning**
* Assessment result page for students
* Grade result page for students
* Session/year and semester management
* Assessments and grades will be grouped by semester
* Upload video and documentation for each course
* PDF generator for students' registration slip and grade result
* Page access restriction
* Storing of quiz results under each user
* Question order randomization
* Previous quiz scores can be viewed on the category page
* Correct answers can be shown after each question or all at once at the end
* Logged-in users can return to an incomplete quiz to finish it and non-logged-in users can complete a quiz if their session persists
* The quiz can be limited to one attempt per user
* Questions can be given a category
* Success rate for each category can be monitored on a progress page
* Explanation for each question result can be given
* Pass marks can be set
* Multiple choice question type
* True/False question type
* Essay question type
* Custom message displayed for those that pass or fail a quiz
* Custom permission (view_sittings) added, allowing users with that permission to view quiz results from users
* A marking page which lists completed quizzes, can be filtered by quiz or user, and is used to mark essay questions
## Current features
- Dashboard: School demographics and analytics. Restricted to only admins
- News And Events: All users can access this page
- Admin manages students(Add, Update, Delete)
- Admin manages lecturers(Add, Update, Delete)
- Students can Add and Drop courses
- Lecturers submit students' scores: _Attendance, Mid exam, Final exam, assignment_
- The system calculates students' _Total, average, point, and grades automatically_
- Grade comment for each student with a **pass**, **fail**, or **pass with a warning**
- Assessment result page for students
- Grade result page for students
- Session/year and semester management
- Assessments and grades will be grouped by semester
- Upload video and documentation for each course
- PDF generator for students' registration slip and grade result
- Page access restriction
- Storing of quiz results under each user
- Question order randomization
- Previous quiz scores can be viewed on the category page
- Correct answers can be shown after each question or all at once at the end
- Logged-in users can return to an incomplete quiz to finish it and non-logged-in users can complete a quiz if their session persists
- The quiz can be limited to one attempt per user
- Questions can be given a category
- Success rate for each category can be monitored on a progress page
- Explanation for each question result can be given
- Pass marks can be set
- Multiple choice question type
- True/False question type
- Essay question type
- Custom message displayed for those that pass or fail a quiz
- Custom permission (view_sittings) added, allowing users with that permission to view quiz results from users
- A marking page which lists completed quizzes, can be filtered by quiz or user, and is used to mark essay questions
# Quick note for future contributors
@ -68,14 +68,19 @@ pip install -r requirements.txt
- Create `.env` file inside the root directory and include the following variables
```bash
# Database config
DB_NAME=[YOUR_DB_NAME]
DB_USER=[DB_ADMIN_NAME]
DB_PASSWORD=[DB_ADMIN_PASSWORD]
DB_HOST=localhost
DB_PORT=[YOUR_POSTGRES_PORT default is 5432]
USER_EMAIL=[YOUR_EMAIL]
USER_PASSWORD=[EMAIL_PASSWORD]
EMAIL_FROM_ADDRESS=[THE DEFAULT FROM ADDRESS FOR SENT EMAILS]
# Email config
EMAIL_FROM_ADDRESS=Django LMS <youremail@example.com>
EMAIL_HOST_USER=[YOUR_EMAIL]
EMAIL_HOST_PASSWORD=[YOUR_EMAIL_PASSWORD]
# Other
DEBUG=True
SECRET_KEY=[YOUR_SECRET_KEY]
```
@ -91,6 +96,7 @@ python manage.py runserver
Last but not least, go to this address http://127.0.0.1:8000
### References
- Quiz part: https://github.com/tomwalker/django_quiz
# Connect with me