|
1 | | -Following this [tutorial](https://www.youtube.com/watch?v=tseqdcFfTUY&list=PLwnoReiC-egEJ-cpIExHV73LZm1yiRN2O&index=3) to deepen my understanding on SpringBoot. |
| 1 | +# Patient Management System |
| 2 | + |
| 3 | +A tool for administrators to manage the patients stored in their Database. SpringBoot is used for the backend, Kafka for real-time messaging and consumption between services, gRPC is used for real-time communication between services, AWS for cloud deployment, and Docker for containerization. This project was done to deepen my understanding of SpringBoot and served as an introduction to microservices architecture. |
| 4 | + |
| 5 | +## Technologies |
| 6 | + |
| 7 | +- SpringBoot |
| 8 | +- Docker |
| 9 | +- Kafka |
| 10 | +- gRPC |
| 11 | +- AWS |
| 12 | +- REST Assured |
| 13 | + |
| 14 | +## Features |
| 15 | + |
| 16 | +The administrator can log in and modify the patient database in three ways: add, update, and delete patients. Each time a new patient is added, the billing service creates a billing account for that patient and Kafka sends a patient created event to the analytics service to observe changes in the system. All services were containerized using Docker and tested on the internal network to simulate a microservices architecture. Lastly, the api gateway service ensures that only the admin with a valid JWT can access sensitive operations of other services. |
| 17 | + |
| 18 | +## The Process |
| 19 | + |
| 20 | +I followed this [tutorial](https://www.youtube.com/watch?v=tseqdcFfTUY&list=PLwnoReiC-egEJ-cpIExHV73LZm1yiRN2O&index=3) to deepen my understanding on SpringBoot. |
| 21 | + |
| 22 | +I commented almost each part of the code since this was all new to me until I got an understanding of the repeated patterns used in SpringBoot. I also made a daily journal entry to document what I learnt and how I squashed bugs that arose due to the tutorial being more than a year old. |
| 23 | + |
| 24 | +## What I Learned |
| 25 | + |
| 26 | +The most important lessons were the foundational lessons. Here is the list below - |
| 27 | + |
| 28 | +- When a client interacts with a database in SpringBoot, they should do so using Data Transfer Objects, or DTOs. A developer hide away the details of the internal objects in the database and can pick and choose which fields can be exposed to the client. |
| 29 | + |
| 30 | +- To create methods that interact with a database, create a service folder and create a Java file that appends the name and "Service" together. An example of this is the PatientService.java file. |
| 31 | + |
| 32 | +- Dependency injection works by creating a constructor for a class where the arguments constitute the dependencies required by that class to function. An example of this is the PatientService that requires PatientRepository, the BillingServiceGrpcClient, and the KafkaProducer as its dependencies. |
| 33 | + |
| 34 | +- For testing different services together, create a Dockerfile with the necessary environment variables and arguments and put them all on the same network such as "internal". This allows you to simulate the services communication with each other in a microservices architecture pattern. |
| 35 | + |
| 36 | +- For services that have a database a repository class file can be created and extended using JPA repository. This gives you basic CRUD functionality out of the box. You can create your own queries using the English language instead of sql statements. |
| 37 | + |
| 38 | +- The model folder stores the properties of the entity that you want to model. |
| 39 | + |
| 40 | +- gRPC, created by Google is preferred for communication between internal services due to it higher speed. |
| 41 | + |
| 42 | +- Despite the tutorial being just one year old, a lot of the bug squashing came down to changes being made to core technologies. An example of this is having to a different image of Kafka, namely Apache Kafka. Another example is the fact that the author uses SpringBoot version and I am using SpringBoot version 4, causing compatibility issues when trying to configure the api gateway service |
| 43 | + |
| 44 | +## Future Work (Improvements) |
| 45 | + |
| 46 | +Below are some of the features that could be implemented to further enhance the experience of the hospital administrator - |
2 | 47 |
|
3 | | -## Extra Features (TO DO) |
4 | 48 | - [ ] Allow a user with admin to add or remove patient from database |
5 | 49 | - [ ] Add Integration test for the above function |
6 | 50 | - [ ] Flow Diagrams to display how services interact with each other |
7 | | -- [ ] Add events such as update, delete patient for analytics-service to track via kafka |
| 51 | +- [ ] Add events such as update, delete patient for analytics-service to track via kafka |
| 52 | + |
| 53 | +## Running the Project |
| 54 | + |
| 55 | +- **Prerequisites:** Java 21+ |
| 56 | + |
| 57 | +- **Run with Docker (example for `patient-service`):** |
| 58 | + - `docker build -t patient-service ./patient-service` |
| 59 | + - `docker run -p 8080:8080 patient-service` (check the service's `application.yml`/`application.properties` for the actual port) |
| 60 | + |
| 61 | +- **Integration tests:** `cd integration-tests && ./mvnw test` (or `mvnw.cmd test` on Windows) |
| 62 | + |
| 63 | +- **Notes:** Many services require environment variables (DB, Kafka, gRPC endpoints). Check each service's `src/main/resources` for required settings before running. |
| 64 | + |
| 65 | +## Video Demo |
| 66 | + |
| 67 | +This will be uploaded soon once I complete the frontend. |
0 commit comments