https://github.com/progrmoiz/saiki
Saiki is a modern LMS for universities that focus on improving teachers and students experience.
https://github.com/progrmoiz/saiki
beginner-friendly djnago-project lms management-system
Last synced: about 2 months ago
JSON representation
Saiki is a modern LMS for universities that focus on improving teachers and students experience.
- Host: GitHub
- URL: https://github.com/progrmoiz/saiki
- Owner: progrmoiz
- License: gpl-3.0
- Created: 2020-02-26T19:08:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T04:29:44.000Z (over 2 years ago)
- Last Synced: 2025-04-02T17:21:21.731Z (2 months ago)
- Topics: beginner-friendly, djnago-project, lms, management-system
- Language: CSS
- Homepage: https://saiki-lms.herokuapp.com/
- Size: 10.5 MB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Saiki is modern LMS for universities that focus on improving teachers and students experience.
---
[](https://github.com/progrmoiz/Saiki/stargazers)
[](/license.txt)
[](https://github.com/progrmoiz/Saiki/graphs/contributors/)
[](https://www.python.org/)
## Table of contents
- [Table of contents](#table-of-contents)
- [Modules and Features](#modules-and-features)
- [Installation](#installation)
- [Requirements](#requirements)
- [Build and Run](#build-and-run)
- [Design of the Project](#design-of-the-project)
* [ERD](#erd)
* [UML Diagrams](#uml-diagrams)
+ [Activity Diagram](#activity-diagram)
+ [Class Diagram](#class-diagram)
+ [Sequence Diagram](#sequence-diagram)
+ [State Chart Diagram](#state-chart-diagram)
+ [Component Diagram](#component-diagram)
+ [Deployment Diagram](#deployment-diagram)
- [Some Screenshots of Saiki](#some-screenshots-of-saiki)
- [Future work](#future-work-ideas)
- [Contributing](#contributing)
- [Contributors ✨](#contributors-)
- [License](#license)
## Modules and Features
- Course
- Notification
- Teachers and Student side
- Stream (forum)
- Announcement
- Assignment
- Result
- Resources
## Installation
To get this project up and running locally on your computer:
1. Clone the repo https://github.com/progrmoiz/Saiki
2. Go to the Saiki directory
3. Create a new database on postgres e.g.: “SAIKI_DB”
4. Add your db config in `settings.py`
5. Assuming you have Python setup, run the following commands (if you're on Windows you may use `py` or `py -3` instead of `python3` to start Python):
```
pip3 install psycopg2-binary
python3 -m pip install Pillow
pip3 install -r requirements.txt
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py collectstatic
python3 manage.py test # Run the standard tests. These should all pass.
python3 manage.py createsuperuser # Create a superuser
python3 manage.py runserver
```
6. Open a browser to http://127.0.0.1:8000/admin/ to open the admin site
7. Open tab to http://127.0.0.1:8000 to see the main site.
8. Change the site name via the Django Admin in the Sites app (/admin/sites/site/).
## Requirements
To install all required modules use the following command in project dir: `pip install -r requirements.txt`
## Build and Run
To run the project use the following command in project dir: `python manage.py runserver`
## Design of the Project
### ERD
### UML Diagrams
#### Activity Diagram
#### Class Diagram
#### Sequence Diagram
#### State Chart Diagram
#### Component Diagram
#### Deployment Diagram
## Some Screenshots of Saiki
|Login|Announcement|Notification|
|--|--|--|
| | | |
|View profile |Edit account|Topbar Notification|
|--|--|--|
||||
|All courses|Course stream|Course people|
|--|--|--|
||||
|Course assignments|All assignments|Assignment Detail|
|--|--|--|
||||
|Course resources|Results|Assignments (teacher)|
|--|--|--|
||||
|Assignment submission (teacher)|Edit assignment (teacher)|Edit grade (teacher)|
|--|--|--|
||||
## Future Work Ideas
- [ ] Currently some part of the application is build with React. Convert the front-end side with SSR React.
- [ ] Currently some module have REST API. Create full REST API for the application must include permission and authorization.
- [ ] Add plagrism support to assignment module.
- [ ] Intigrate Turnitin with assignment module.
- [ ] Add support for google docs, spreadsheets and slides so user can create directly from assignment detail page.
- [ ] Add report generation module to generate any kind of report (academic progress, status, result, transcript, etc).
- [ ] Add attendance module.
- [ ] Add more than one instructor support to courses.
- [ ] Course can be created by anyone (Person who create the course become instructor).
- [ ] Course can be join via invite code or link.
- [ ] Improve Stream (forum) inside Course.
- [ ] Integrate Zoom so instructor can schedule meeting.
- [ ] Add support for live meeting within the application using Skype.
- [ ] Create a mini social network within the orgnaziation (so student & teacher under same organization can talk to each other).
- [ ] Add calendar integration & scheduling system.
- [ ] Create scripts to automate installation.
- [ ] Create scripts to dump lots of dummy data.
- [ ] Create Oauth provider so other app can connect with this application.
- [ ] Create a marketplace for third-party application.
- [ ] have more ideas add it here...
## Contributing
Please check the [CONTRIBUTING.md](CONTRIBUTING.md) file for contribution instructions and naming guidelines.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Abdul Moiz
💻 🤔
Abdul Samad
💻 📖
muhammad-jawad-92
💻 📖
This project follows the [all-contributors](https://allcontributors.org) specification.
Contributions of any kind are welcome!
## License
Copyright © 2020, [Moiz Farooq](https://github.com/progrmoiz). Released under the [GNU GPLv3](LICENSE).
[:arrow_up: __Back To Top__](#saiki)