🏢 Ascenda Admin Proxy App

📚 Table of Contents

1. Quick Start
2. System Architecture
3. Service Archtiecture
4. Frameworks and Databases Utilised
5. Contributors

We're immensely grateful to Professor OUH Eng Lieh for his guidance and expertise during the development of the Admin Proxy App. His strategic insights and focus on design patterns have been pivotal in shaping the project. 😊

Quick Start (For Local Deployment)

Prerequisites

1. Docker (Windows | MacOS)
2. GNU Make (Windows | MacOS) - Optional but recommended

Instructions (Make)

1. To start the docker deployment, run the following command:

$ make up

That's it! All images are hosted on Docker Hub for ease of access.

2. Once you are done, you can tear down the deployment:

$ make down

Alternatively, to tear down cleanly:

$ make down-clean

Do note that this will remove all containers associated with the project, orphaned containers, and Docker volumes. Do not run this command if you would like to keep your volumes.

Instructions (Docker Compose)

These instructions are if you do not have Make on your system, and do not want to install it.

1. To start the docker deployment, run the following command:

$ docker compose -f deployment/local/docker-compose.yml -p itsa up

To deploy in detached mode, add the -d flag:

$ docker compose -f deployment/local/docker-compose.submission/yml -p itsa up -d

2. Once you are done, you can tear down the deployment:

$ docker compose -f deployment/local/docker-compose.submission/yml -p itsa down

System Architecture

Service Architecture

Frameworks and Databases Utilised

Services and UI

        

Golang · Springboot · Typescript

Databases

        

Aurora Postgresql · Elasticache Redis · S3

Communication

     

gRPC · SES

Deployment

                 

Docker · Kubernetes · Route 53 · CloudFront · WAF · Elastic Kubernetes Service

Others

                    

Terraform · ECR · Cloudwatch · ACM · KMS · Shield · IAM

Contributors

G2 Team 2

Song Jihoon	Yue Zheng Ting	Lim Huei Ming	Angelita Kng
Kek Zhi Hui	Guan Bingyan	Goh Ray Jiet