Introduction

This is the main repository for the Tempcheck application.

The original codename was Vishnu hence the django app is named as such.

Development

• Setup: Frontend
• Setup: Postgres service
• Setup: Django
• Adding/viewing data in database
• Changing database schema

Setup: Environment variables

Aan .env file which is a definition of all the environment variables needed for Postgres and Azure blob storage configurations.

DEPLOYMENT_HOSTNAME=

POSTGRES_DB=
POSTGRES_USER=
POSTGRES_PASSWORD=
POSTGRES_HOST=
POSTGRES_PORT=

MANDRILL_API_KEY=

REPORT_INTERVAL_SECONDS=
REPORT_INTERVAL_MINUTES=
REPORT_INTERVAL_HOURS=
REPORT_INTERVAL_DAYS=
REPORT_EXPECTED_DAILY=

REPORT_EMAIL_SUBJECT=
REPORT_FROM_EMAIL=
REPORT_FROM_NAME=
REPORT_TO_EMAIL=
REPORT_TO_NAME=

Setup: Frontend

cd frontend

Run npm install if the node_modules don't already exist in your local. Otherwise, run

npm run serve

This starts the webpack server on port 8080 that will serve the frontend. Any frontend changes should autoreload by default.

The base Django app has been configured to forward frontend requests to the webpack server. This step is only required for development. In production, the assets will be built and bundled as one single application.

Setup: Postgres service

Start a Postgres service in the background by running

docker-compose up -d

Setup: Django

First, activate the Python environment using conda activate or venv. If not available, install using conda or venv.

# Using conda
conda install -f requirements.txt

# Using venv
python -m venv venv
pip install -r requirements.txt

Then run the following:

python manage.py makemigrations
python manage.py migrate

Create a superuser:

python manage.py createsuperuser

Finally, at the root of the project, run

python manage.py runserver

This starts the django dev server on http://127.0.0.1:8000/ and should be the main interface for the app.

Adding/viewing data in database

You may also query the database directly by running psql in the running Postgres instance:

source .env
docker exec -it \
    vishnu_postgres_vishnu_1 \
    psql \
    -U ${POSTGRES_USER} \
    -a ${POSTGRES_DB}

Changing database schema

If you change the schema of the database, make sure to run:

python manage.py makemigrations

and

python manage.py migrate

Setup report generation

Update .env with the follow values:

MANDRILL_API_KEY=

REPORT_INTERVAL_SECONDS=
REPORT_INTERVAL_MINUTES=
REPORT_INTERVAL_HOURS=0
REPORT_INTERVAL_DAYS=0
REPORT_EXPECTED_DAILY=1

REPORT_EMAIL_SUBJECT=
REPORT_FROM_EMAIL=
REPORT_FROM_NAME=
REPORT_TO_EMAIL=
REPORT_TO_NAME=

• More information on report interval is available here.
• REPORT_TO_EMAIL and REPORT_TO_NAME are comma seperated values e.g. test@gmail.com, test2@gmail.com.
• Currently, app and values stored in DB are in UTC timezone. Some datetimes are then hardcoded in UTC then converted to SGT time.

Deployment

The app can either be deployed using:

• docker-compose
• helm

Refer to the Deployment README for details.

APIs

The available APIs are available at urls.py.

Acknowledgements

This project is supported by the National Research Foundation, Singapore under its AI Singapore Programme (AISG-RP-2019-050). Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not reflect the views of National Research Foundation, Singapore.