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.
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.
docker compose -f develop.yaml build
docker compose -f develop.yaml up
docker compose -f develop.yaml down
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
http://localhost:8000/admin/
http://localhost:8000/api/schema/
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.
CC BY-NC-ND 4.0