Update readme.md

This commit is contained in:
2025-09-28 11:02:04 +00:00
parent 57348b5ff5
commit a96111316a
+25
View File
@@ -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.