Task API

Prerequisites

• Python >= 3.7 ⤴
• Pipenv ⤴
• Taskfile ⤴
• Create .env from .env.sample

Local Setup

• Execute the following command to install the dependencies

  task setup

• Execute the following command to run the migrations

  task migrate

• Execute the following command to create a super user

  task user

• Execute the following command to run the application

  task run

Docker Setup

• Execute the following command to run the container

  docker-compose up -d

• Execute the following command to stop the container

  docker-compose down

Swagger Endpoint

 http://<host>:<port>/api/schema/swagger-ui/

Project Structure

./
├── apps/
│   ├── common/
│   │   └── permissions.py
│   ├── labels/
│   │   ├── migrations/
│   │   ├── admin.py
│   │   ├── apps.py
│   │   ├── models.py
│   │   ├── serializers.py
│   │   ├── tests.py
│   │   ├── urls.py
│   │   └── views.py
│   └── tasks/
│       ├── migrations/
│       ├── admin.py
│       ├── apps.py
│       ├── models.py
│       ├── serializers.py
│       ├── tests.py
│       ├── urls.py
│       └── views.py
├── core/
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── .env.sample
├── Dockerfile
├── Pipfile
├── README.md
├── Taskfile.yml
├── docker-compose.yml
├── manage.py
└── requirements.txt