While emails are used to identify the teachers and students, auto-incrementing bigint id fields are used as primary keys for the teachers and students tables for better extensibility (e.g. we may want to allow teachers/students to update their email addresses in the future)

Prerequisites

• Docker
• Docker Compose

Environment variables
Set the environmental variables as follow

Run the following to spin up the containers

bash run.sh --dev

Alternatively, run

docker-compose -f docker-compose-dev.yml up -d

*The only difference between running the contains in dev/prod environment is that the nginx server is configured for HTTPS instead of HTTP in the latter, as the SSL certificate is associated with the Elastic IP address which is only accessible in the production environment.

After the containers are up, you can access the backend at http://localhost (exposed by default on port 80)

Seeding
For seeding, send a POST request with an empty body to api/seed

Docker compose
The docker-compose service consists of 3 containers:

• HTTP server in Golang
• PostgreSQL database
• Nginx reverse proxy

For local development, the database container is also exposed on port 5432 on localhost for easy debugging

The API is deployed on AWS EC2 at https://54.254.110.35

The EC2 instance is associated with an Elastic IP address, so that we can keep the same address over multiple boot cycles of the instance. A TLS/SSL certificate for this particular Elastic IP address is also installed on the nginx proxy in production environment, to enable the instance to handle HTTPS traffic.

Terraform is used to quickly launch and tear down the instance, with secrets stored in Hashicorp Vault Secrets.

Automated unit-testing is triggered via GitHub actions whenever a new commit is made, and when the master branch receives a pull request.

    .
    ├── ent
    │   ├── ...
    │   │   
    │   ├── schema
    │   │   ├── student.go
    │   │   └── teacher.go
    │   │
    │   ├── ... (generated files by ent)
    ├── pkg
    │   ├── api
    │   │   ├── api.go
    │   │   ├── api_test.go
    │   │   ├── errors.go
    │   │   └── errors_test.go
    │   ├── database
    │   │   ├── database.go
    │   │   ├── students.go
    │   │   └── teachers.go
    │   ├── handlers
    │   │   ├── commonstudents.go
    │   │   ├── commonstudents_test.go
    │   │   ├── register.go
    │   │   ├── register_test.go
    │   │   ├── retrievefornotification.go
    │   │   ├── retrievefornotification_test.go
    │   │   ├── suspend.go
    │   │   └── suspend_test.go
    │   ├── middleware
    │   ├── router 
    │   ├── seed
    │   ├── server
    │   └── testutil
    ├── terraform
    ├── certificate.crt
    ├── go.mod
    ├── go.sum
    ├── main.go
    ├── (nginx configs...)
    └── (Dockerfiles, docker-compose.yml files...)

This project follows conventional commits guideline for commit messages. See the table below for the list of commit types.