Age groups enrollment API

This project implements an API for managing age groups and processing enrollments.

Tools

API Documentation

Age Groups

• Register a new age group

  • POST /age-groups/
  • Request Body:

    {
      "min_age": 10,
      "max_age": 15
    }

• Delete an age group

  • DELETE /age-groups/{age_group_id}

• View existing age groups

  • GET /age-groups/

Enrollments

• Request enrollment

  • POST /enrollments/
  • Request Body:

    {
      "name": "Maria",
      "age": 21,
      "cpf": "12345678900"
    }

• Check enrollment status

  • GET /enrollments/{enrollment_id}/status

• View existing enrollment

  • GET /enrollments/

How to run

1. Clone this repository:

git clone https://github.com/montenegroleticia/AgeEnrollmentAPI.git

2. Copy the example environment file and configure the environment variables:

cp .env.example .env

3. Build:

docker compose build

4. Run API and DB:

docker compose up

5. Access aplication:

localhost:8000

6. Run tests with pytest:

docker compose run api pytest

7. Run lint with flake8:

docker compose run api flake8