Skip to content

4bdu1/ssms-api

Repository files navigation

SSMS API

Simple Student Management System to go through SRE Bootcamp exercises.

Architecture Diagram

alt c4-context-diagram

Application Structure (Code)

alt code-organization

Hexagonal Architecture (Dependency Graph)

alt dependency-graph

Domain Driven Design

Aggregate Root: Student

Attributes: StudentID, StudentName, EmailAddress, EnrollmentDate

Methods

  • initAddStudent()

ValueObjects

  • StudentID
  • StudentName
  • EmailAddress

Deployment

Local deployment is done using tilt to run application in k8s locally (Docker Desktop for eg.).

Run mvn clean install from root to install all packages from modules.

Make sure you have docker desktop installed and kubernetes started. Change directory into the infrastructure folder and kubernetes. Run tilt up to start application. This assumes you have a local PostgresDB running on port 5432 with username ussms and default password ussms. This can be changed using the DB_USER and DB_PASS env vars. DB_NAME controls the database name. By default this is ssms.

To use the Makefile, simply make sure you have make installed and run

make app -- to start application (this checks if postgres is up and running before)

make down -- delete deployments


NB: This project uses Conventional Commits

About

Simple Student Management System to go through SRE bootcamp exercises. (https://playbook.one2n.in/sre-bootcamp/sre-bootcamp-exercises)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published