Skip to content

Commit 992abc7

Browse files
authored
Revise README for DevOps CI/CD Pipeline project
Updated README to include project overview, tech stack, CI/CD workflow, and features.
1 parent 33efaff commit 992abc7

1 file changed

Lines changed: 81 additions & 1 deletion

File tree

README.md

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,81 @@
1-
# devops-app
1+
# 🚀 DevOps CI/CD Pipeline (Docker + GitHub Actions)
2+
3+
This project demonstrates a complete CI/CD pipeline using Docker, Docker Compose, and GitHub Actions with a self-hosted runner.
4+
5+
---
6+
7+
## 🧠 Overview
8+
9+
The application is a simple Flask API containerized with Docker and automatically deployed on every push using GitHub Actions.
10+
11+
---
12+
13+
## ⚙️ Tech Stack
14+
15+
* Python (Flask)
16+
* Docker
17+
* Docker Compose
18+
* GitHub Actions (CI/CD)
19+
* Self-hosted runner
20+
21+
---
22+
23+
## 📦 Project Structure
24+
25+
```
26+
my-devops-app/
27+
28+
├── app/
29+
│ └── app.py
30+
├── Dockerfile
31+
├── docker-compose.yml
32+
├── requirements.txt
33+
└── .github/workflows/ci.yml
34+
```
35+
36+
---
37+
38+
## 🔄 CI/CD Workflow
39+
40+
1. Push code to `main`
41+
2. GitHub Actions triggers pipeline
42+
3. Self-hosted runner executes:
43+
44+
* `docker compose down`
45+
* `docker compose up -d --build`
46+
4. Application is updated automatically
47+
48+
---
49+
50+
## 🐳 Run Locally
51+
52+
```bash
53+
docker compose up -d --build
54+
```
55+
56+
Then open:
57+
58+
```
59+
http://localhost:5000
60+
```
61+
62+
---
63+
64+
## 📌 Features
65+
66+
* Automated deployment on push
67+
* Containerized application
68+
* Service orchestration with Docker Compose
69+
* Self-hosted CI runner
70+
71+
---
72+
73+
## 💡 Why this project
74+
75+
This project demonstrates practical DevOps skills:
76+
77+
* CI/CD pipeline design
78+
* Containerization
79+
* Infrastructure automation
80+
81+
---

0 commit comments

Comments
 (0)