From 9a1639b6f08c61e9b571e779d66990e143d8c18c Mon Sep 17 00:00:00 2001 From: Ayush Acharjya Date: Thu, 12 Dec 2024 00:59:31 +0000 Subject: [PATCH] update readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 5a7f685..31673bb 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ NOTE : Docker and dos2unix must be installed in the EC2 instance. sudo apt-get update && sudo apt-get install -y dos2unix ``` +There is also an OpenAPI spec present inside `apps/backend` which documents all the API endpoints, so the API can be used by developers. + ## System Design Below is the system design for the application. @@ -109,6 +111,9 @@ This will shut down the running services and remove the containers. --- +### Report +The report of the prototype could be found in the `Report PDF & LaTeX Files` + ### Troubleshooting - **Missing Docker Compose**: Ensure that Docker Compose is installed. You can verify by running `docker-compose --version`. If not installed, follow the installation instructions [here](https://docs.docker.com/compose/install/).