Updating README.md File
نجحت جميع الفحوصات
CI - Fruit API / build-and-test (push) Successful in 38s

هذا الالتزام موجود في:
ahmedgamalyousef
2025-10-01 20:52:31 +03:00
الأصل 9a984f1951
التزام 63fb40bb5e

عرض الملف

@@ -8,15 +8,17 @@ The project also includes **logging**, a **log monitoring script**, and **automa
## 📂 Project Structure
```
fruit-api/
│── fruit_api.py # Main Flask API
│── requirements.txt # Dependencies
│── Dockerfile # Docker support
│── log_monitor.sh # Log monitoring script
│── test_api.sh # Automated testing script
│── test_results.log # API tests logs
│── fruit_api.log # API logs
│── README.md # Documentation
│── .gitignore # Ignore venv/logs
│── fruit_api.py # Main Flask API
│── requirements.txt # Dependencies
│── Dockerfile # Docker support
│── log_monitor.sh # Log monitoring script
│── test_api.sh # Automated testing script
│── test_results.log # API tests logs
│── fruit_api.log # API logs
│── README.md # Documentation
│── .gitignore # Ignore venv/logs
│── .github/workflows/ci.yml # CI workflow for testing
```
## 📌 Features
@@ -28,6 +30,8 @@ fruit-api/
- Bash script for monitoring logs (`log_monitor.sh`) with **error alerts (4xx/5xx)**
- Bash script for automated API testing (`test_api.sh`) with ✅ / ❌ results
- Swagger/OpenAPI documentation at `/docs`
- `CI/CD` pipeline for automated testing
---
@@ -163,6 +167,20 @@ After starting the API, open:
---
## ⚡ CI/CD Pipeline
This project uses **Continuous Integration (CI)** to ensure the API works correctly after every code change.
### Workflow
- Triggered on every **push** or **pull request** to `main` branch.
- Installs dependencies (`requirements.txt`).
- Starts the API in the background.
- Runs automated tests (`test_api.sh`).
- Pipeline **fails** if any test ❌ fails.
---
## 🐳 Docker Support
### Build the image
@@ -176,4 +194,4 @@ docker run -p 5000:5000 fruit-api
```
## 🎥 Project Record
[Watch the Demo](https://app.gitpasha.com/AhmedGamalYousef/Building-API-and-Monitoring-Logs/src/branch/main/demo/APIProject.mp4)
[Watch the Demo](https://app.gitpasha.com/AhmedGamalYousef/Building-API-and-Monitoring-Logs/src/branch/main/demo/APIProject.mp4)