Admissions Portal

Local development

Install poetry

$ pip3 install poetry

Install Dependencies

$ python3 -m venv .venv
$ source .venv/bin/activate
$ poetry install

Run Tests & checks

$ make

Run Local Server

# make dev-run

s3 bucket structure

├── coding_test.ipynb
├── candidate-dist
│   ├── candidate.coding_test.zip`
│   ├── candidate.slu01.zip
│   ├── candidate.slu02.zip
|   └── candidate.slu03.zip
├── profiles/id-card
│   ├── user_1
│   |       └── file_2
├── applications
│   ├── coding_test
│   |   └── user_1
|   │       ├── file_1
|   │       └── file_2
│   ├── slu01
│   |   └── user_1
|   │       └── file_1
│   ├── slu02
│   |   ├── user_1
|   │   |   ├── file_1
|   │   |   ├── file_2
|   │   |   └── file_3
│   |   └── user_2
|   │       └── file_1
│   └── slu03
│       └── user_1
|           └── file_1
└── payments
    ├── payment_proof
    │   ├── user_1
    │   |   ├── file_1
    |   |   └── file_2
    |   └── user_2
    │       └── file_1
    └── student_id
        └── user_1
            └── file_1

Deployment Details Summary

Requirements

AWS RDS Instance (PostgreSQL)

• DB details (host, port, user, pw) are taken from the environment
• It would be nice to be able to query the database without going through the service

AWS S3 Bucket

• Read permission required
• Write permission required
• Bucket name is taken from the environment

Django Commands

These must be ran on the instance.

Create Admin User:

$ cd app/adm_portal
$ python manage.py create_admin --email [email protected] --password 

Create Staff User:

$ cd app/adm_portal
$ python manage.py create_staff --email [email protected] --password 

Docker Image

DockerFile

(Currently using python3.8-buster instead of python3.8-alpine because of postgresql dependency psycopg2)

ci

Building and Pushing new docker image on green commits on master

@dockerhub

Production ENV

• DJANGO_SETTINGS_MODULE: adm_portal.settings.prod

• DJANGO_SECRET_KEY: secret, can be generated

• POSTGRES_NAME: dependent on the created AWS RDS instance

• POSTGRES_USER: dependent on the created AWS RDS instance

• POSTGRES_PASSWORD: dependent on the created AWS RDS instance

• POSTGRES_HOST: dependent on the created AWS RDS instance

• POSTGRES_PORT: dependent on the created AWS RDS instance

• ELASTIC_EMAIL_API_KEY: provided by us

• ELASTIC_EMAIL_SENDER: provided by us

• S3_BUCKET_NAME: dependent on the created S3 Bucket name

• ADM_GRADER_URL: dependent on the AWS LAMBDA (for now it can be provided by us)

• ADM_GRADER_AUTH_TOKEN: secret, can be generated, needs to be consistent with the one on the AWS LAMBDA

Nice to have / Later

• SSH access?
• logs on cloudwatch?
• take secrets (for example ADM_GRADER_AUTH_TOKEN) from AWS SECRETS MANAGER
• Deal with admin/staff creation on deploy (how to manage secrets?)