This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
You need linux
machine and Python package manager(pip
) to run the project.
sudo apt install python3-pip
sudo apt install git
git clone https://github.com/sevbo2003/student-attendance-system.git
cd student-attendance-system
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
Create .env
file and fill it with your credentials like .env.example
touch .env
# .env
DEBUG=True # or False
SECRET_KEY=your_secret_key
ALLOWED_HOSTS=*
# db
DB_NAME=
DB_USER=
DB_PASSWORD=
DB_HOST=
DB_PORT=
# redis
REDIS_URL=redis://user:password@host:port
# cors
CORS_ORIGIN_WHITELIST=
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver
sudo apt install redis-server
redis-server
celery -A config worker -l info
celery -A config beat -l info
Here you can find important APIs to use the application
POST /api/token/
{
"email": "your_email",
"password": "your_password"
}
GET /accounts/users/
GET /accounts/teachers/
GET /attendance/groups/
GET /attendance/group/{group_id}/subjects/
GET /attendance/group/{group_id}/students/
GET /attendance/attendance-report/
GET /dailystat/
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
git checkout -b feature/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feature/AmazingFeature
)Distributed under the MIT License. See LICENSE
for more information.
Made with ❤️ by Abdusamad