From a96111316a06f626430082e43480d881f527ac9f Mon Sep 17 00:00:00 2001 From: ghaymah_dev Date: Sun, 28 Sep 2025 11:02:04 +0000 Subject: [PATCH] Update readme.md --- readme.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/readme.md b/readme.md index 9452327..36841b2 100644 --- a/readme.md +++ b/readme.md @@ -55,3 +55,28 @@ Build a demo API (e.g., for a store, booking system, or any domain of your choic + +## Submission Guidelines +1. **GitPasha Deployment**: + - Push all files to a **public GitPasha repository** ([https://app.gitpasha.com/](https://app.gitpasha.com/)). + - Repository must include: + - API source code. + - Bash scripts (`monitor.sh`, `test_api.sh`). + - Log files (sample or generated). +2. **Documentation**: + - A `README.md` with: + - API setup instructions. + - Script usage examples. + - Swagger link (e.g., `http://localhost:5000/docs`). + - **GitPasha repository URL**. +3. **Demo**: + - Run the API, trigger errors, and show alerts in action during presentation. + + +--- +**Note**: +- The Ghaymah endpoint URL and authentication details will be shared later. +- Ensure the GitPasha repository is **public** and well-organized. + + +