Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ayush272002 committed Dec 12, 2024
1 parent e4699b1 commit 9a1639b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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/).
Expand Down

0 comments on commit 9a1639b

Please sign in to comment.