Setup

IMPORTANT: Redis and cron are not available for windows-systems; if you have no choice but to use a windows machine, we suggest using a WSL instance to setup the repository, although it is not an ideal solution as sometimes, the code breaks on WSL.

Respository Setup

1. python -m venv env

2. source env/bin/activate

   • source env/Scripts/activate in Windows.

3. python -m pip install pip-tools

4. sh scripts/install_dependencies.sh

5. Copy the .env file for the backend into the folder and fill the values as per your local configuration.

6. crontab -e to open the cron config file.

   1. * * * * * path/to/python/executable path/to/manage.py runcrons --silent to enable the cron jobs defined in the system.
   2. ^o to write the changes to the file buffer (press Enter when prompted)
   3. ^x to exit the file editor.

7. python manage.py makemigrations

8. python manage.py migrate

9. python manage.py createsuperuser

   FOR LOCAL DEV MACHINE ONLY

   USERNAME: admin
   EMAIL: admin@admin.com
   PASSWORD: password

10. sh scripts/run_server.sh

.ENV File Format

## General Settings:
APP_NAME = "The name of your application"
DOMAIN_URL = "The domain of your application"
OWNER_EMAIL = "Your official email address"
CONTACT_EMAIL = "Contact email for your application"


## System Settings:
SECRET_KEY = "Secret key for site encryption (one-way)"
DEBUG = True | False
ENV_TYPE = "DEV" | "PROD" | "TEST" | "QA"
ALLOWED_HOSTS = "host 1, host 2, host 3, host 4, ..."
JWT_ALGORITHM = "HS256"
CORS_ORIGIN_WHITELIST = "origin 1, origin 2, origin 3, origin 4, ..."

## Database Settings:
DB_NAME = "Name of SQL database"
DB_HOST = "Host for SQL database"
DB_PORT = "Posrt for SQL database"
DB_USER = "Username for SQL database"
DB_PASSWORD = "Password for SQL database"

## MongoDB Settings:
MONGO_URI = "URI for MongoDB"
MONGO_NAME = "Name of MongoDB cluster"
MONGO_HOST = "Host for MongoDB cluster"
MONGO_PORT = "Port for MongoDB cluster"
MONGO_USER = "Username for MongoDB cluster"
MONGO_PASSWORD = "Password for MongoDB cluster"

## Internationalization Settings:
LANGUAGE_CODE = " "
TIME_ZONE = " "
USE_I18N = True | False
USE_TZ = True | False

## Authentication Settings:
OTP_ATTEMPT_LIMIT = How many login attempts before being blocked
OTP_ATTEMPT_TIMEOUT = How long to block for

## Amazon Web Services Settings:
SNS_SENDER_ID = ""
AWS_ACCESS_KEY_ID = ""
AWS_SECRET_ACCESS_KEY = ""
AWS_REGION_NAME = ""

Documentation

1. Postman
2. JSON