zeton_django

Zeton is an application that support behavioral therapy. Token system for the child. Allows you to earn points for your activities and exchange them for prizes.

Application goals

Developing deficit (desirable) behaviour
Reduction of undesired behaviour
Generating and maintaining therapy effects over time

Dependencies

Python 3.12
pip
Django 4.2
Django Rest Framework
Postgres

Contributing

Before you make any commits to this repository make sure to install pre-commit hooks:

# install pre-commit on your machine using pipx if you haven't already
❯ pipx install pre-commit
# install hooks defined in .pre-commit-config.yaml (only needs to be done once)
❯ pre-commit install
# (optional) invoke pre-commit against all files
❯ pre-commit run -a

Docker and docker-compose

Install Docker

If you use Linux and need to use sudo before docker compose command just follow step below:

Manage Docker as a non-root user: Post-installation steps for Linux

We use Docker Compose V2 which is integrated into Docker Desktop versions. For more information, see Migrate to Compose V2
Commands:

If you want to build and run containers - you can do it in two ways:

Build and run containers:

docker compose up -d --build

Build the image:
docker compose build

Fire up containers:
docker compose up

Or fire up containers in detached mode:
docker compose up -d

Database: postgres (Django, docker-compose)

To make migrations and migrate:

docker compose exec web python manage.py makemigrations
docker compose exec web python manage.py migrate

To create superuser:
docker compose exec web python manage.py createsuperuser

To populate data

To populate data using fixtures:
make load_data

To rebuild database

If you want rebuild database, you can use command:
docker compose down -v

WARNING! This command will delete all data from the database

Register and login user in the Django app

Go to http://localhost:8000/admin and create a new user.

Access API

Auth

To run app with tokens, set .local.env ENVIRONMENT to PROD.

Go to http://localhost:8000/api/users/register/

You may use Postman for that.

As you can see below, you can fill the body form-data with info:

After that you can hit http://localhost:8000/api/users/students/ with GET method and put into Headers key and value.

Then you have access to private endpoint.

More private endpoints:

Go to http://localhost:8000/api/users/students/

You may expect this result:

[
    {
        "pk": 1,
        "email": "wojtek-zeton@mailinator.com",
        "username": "wojtek",
        "first_name": "Wojtek",
        "last_name": "",
        "total_points": 250
    },
    {
        "pk": 2,
        "email": "kuba-zeton@mailinator.com",
        "username": "kuba",
        "first_name": "Kuba",
        "last_name": "",
        "total_points": 120
    }
]

Go to http://localhost:8000/api/users/students/1

Result:

{
    "pk": 1,
    "email": "wojtek-zeton@mailinator.com",
    "username": "wojtek",
    "first_name": "Wojtek",
    "last_name": "",
    "total_points": 250
}

Go to http://localhost:8000/api/users/prizes/

[
    {
        "pk": 1,
        "student": "1",
        "name": "Puszka Coca-cola",
        "value": 10
    },
    {
        "pk": 2,
        "student": "2",
        "name": "1 godzina na basenie",
        "value": 30
    }
]

Go to http://localhost:8000/api/users/prizes/1

Result:

{
    "pk": 1,
    "student": "1",
    "name": "Puszka Coca-cola",
    "value": 10
}

Similarly, tasks:

Go to
http://localhost:8000/api/users/tasks/
http://localhost:8000/api/users/tasks/1

Points endpoints

There are currently several enpoints responsible for managing student points available:

api/users/points/ accesible with a GET request and followed by a query string pointing to a student primary key.
For example: api/users/points/?studentId=2 should return Point instances assigned to the student with pk=2
api/users/points/ accessible with POST request, payload in a given format is required:

{
    "value": 40,
    "assigner": 1,
    "student": 1,
}

As a result you should receive a response similar to the following:

{
    "pk": 5,
    "value": 40,
    "assigner": 1,
    "student": 1,
    "assignment_date": "2021-01-26T21:41:04.952509Z"
}

Tests

There are also some tests, checking above endpoints, available in the users/tests/users/test_points.py module.

To execute the tests simply call docker compose exec web pytest (you can add the -v flag for a verbose ouput).

Planned endpoints

GET /api/students

List all students for logged in caregiver

POST /api/students (future)

Add new student for a caregiver

GET /api/students/id:int

Retrieve information about student with given ID:

...
total_points

PATCH /api/students/id:int

Update student

GET /api/students/id:int/points

List history of points received by student

POST /api/students/id:int/points (no longer needed)

~~Add new points to student~~ Points should be automatically added when completing a task (another endpoint)

GET /api/students/id:int/tasks

List of tasks assigned to student

POST /api/students/id:int/tasks

Add new task for student

PATCH /api/students/id:int/tasks/<task_id:int>

Edit existing task + soft delete

GET /api/students/id:int/prizes

List of prizes assigned to student

POST /api/students/id:int/prizes

Add new prize for student

PATCH /api/students/id:int/prizes/<prize_id:int>

Edit existing prize + soft delete

POST /api/caregivers (future)

Add new caregiver

POST /api/roles (future)

Add new role (association between student and caregiver)

Swagger ui

Our project supports a minimal swagger UI setup for Django Rest Framework, described here.
You can access it with http://localhost:8000/swagger-ui endpoint.
Openapi compliant text documentation: http://localhost:8000/openapi

zetonteam / zeton_django