README.md

Table of Contents

• Getting Started
• Prerequisites
• Installing
• Running the App

Getting Started

To get started, follow the instructions below.

Prerequisites

To run this project, you will need to have the following installed:

• git
• anaconda (optional)
• python: 3.12

Installing

To install this project, run the following command in your terminal:

1. Activate the project's virtualenv:

pipenv shell

Or

make start-env

2. Install the dependencies

pipenv install

Running the App

1. Activate the project's virtualenv, run:

pipenv shell

Or

make start-env

2. Copy .env file from .env.example

cp ./.env.example .env

3. Start the application

python manage.py runserver <PORT>

OR

make run-server port=<PORT>