https://github.com/katarzynaheller/school_tracker
RESTful app for tracking child's progress in school and chat with teacher
https://github.com/katarzynaheller/school_tracker
edtech edtech-backend education learning-management-system python3 school-app school-management-system
Last synced: 6 months ago
JSON representation
RESTful app for tracking child's progress in school and chat with teacher
- Host: GitHub
- URL: https://github.com/katarzynaheller/school_tracker
- Owner: katarzynaheller
- License: other
- Created: 2023-03-20T11:34:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-06T14:02:01.000Z (10 months ago)
- Last Synced: 2024-12-06T15:23:19.677Z (10 months ago)
- Topics: edtech, edtech-backend, education, learning-management-system, python3, school-app, school-management-system
- Language: Python
- Homepage:
- Size: 140 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SCHOOL TRACKER
Backend part (API) for school app designed to manage children/students activities, events and progress in educational institution. App is build with several components: for planning events, reporting meal and behaviour status and for chat with teacher.
## Purpose:
Project's purpose is to improve communication between parent and teacher as well as provide help for parents in tracking child's achievements and preparing for planned events. Funtionalities can be adjusted to the type of insitution. For example: meals can be tracked for nursery but grades/points for school.
## How to run app locally (Docker):
### Build image locally:
`docker compose -f develop.yaml build`
### Run docker containers (Django and PostgreSQL):
`docker compose -f develop.yaml up`
### Remove containers:
`docker compose -f develop.yaml down`
### Create superuser
Enter the app's container shell and execute Django command to create superuser.
`docker compose -f develop.yaml exec app bash`
`python manage.py create superuser`
### Login to app
`http://localhost:8000/admin/`
### Download schema
`http://localhost:8000/api/schema/`
### Run tests
Enter the app's container shell and execute Django command to run tests.
`docker compose -f develop.yaml exec app bash`
`python manage.py test`
// Note: when file has custom name different that "docker-compose.yaml" docker deamon expects `-f` flag with correct yaml's file name in terms to find it. File in this repository is named this way to provide more flexability when need for different environment will arise.
# Licence:
CC BY-NC-ND 4.0