Tutor's Companion

• Description
• Requirements
• Installation
• Environment variables
• Running the app

A backend application to manage a small private tutoring business.

• Python 3.9.6
• Django 4.2.5
• Django REST Framework 3.14.0

Once you've cloned the repository, your next step is to establish a virtual environment to ensure a pristine Python installation. This can be achieved by executing the following command:

$ python -m venv env

After this, it becomes essential to activate the virtual environment. For additional details on this step, you can find more information here:

To install all the necessary dependencies, execute the command:

$ pip install -r requirements.txt

Create a .env file with the following in the root

# server mode
$ DEBUG=<DEBUG>

# app secret
$ SECRET_KEY=<SECRET_KEY>

# database name
$ DATABASE_NAME=<DATABASE_NAME>

# database host
$ DATABASE_HOST=<DATABASE_HOST>

# database user
$ DATABASE_USER=<DATABASE_USER>

# database user password
$ DATABASE_PASSWORD=<DATABASE_PASSWORD>

# database port
$ DATABASE_PORT=<DATABASE_PORT>

To start up the Django's development server, navigate to the root of the project and run the command:

$ python manage.py runserver