Description
Currently, the repository lacks a detailed README.md file that explains what the project does, its architecture, and how to set it up locally. This makes it difficult for new contributors and users to get started.
I propose adding a comprehensive README.md that includes:
- Features and Architecture Overview: Explaining the FastAPI, MySQL, Elasticsearch, and Keycloak stack.
- Prerequisites: What needs to be installed (Docker, Python).
- Setup Instructions: Clear steps on how to run the project using the provided
scripts/up.sh for Docker Compose, or how to run it natively for local development.
- Usage Guide: Pointing to the Swagger UI (
http://localhost:8000/docs).
- Monitoring & Testing: Instructions for running tests and spinning up Prometheus/Grafana.
Proposed Changes
Add a new README.md to the root directory. (I have a draft ready that I can propose via a Pull Request).
I am an ESOC 2026 applicant .
Description
Currently, the repository lacks a detailed
README.mdfile that explains what the project does, its architecture, and how to set it up locally. This makes it difficult for new contributors and users to get started.I propose adding a comprehensive
README.mdthat includes:scripts/up.shfor Docker Compose, or how to run it natively for local development.http://localhost:8000/docs).Proposed Changes
Add a new
README.mdto the root directory. (I have a draft ready that I can propose via a Pull Request).I am an ESOC 2026 applicant .