Skip to content

Commit 7606c17

Browse files
author
Syntax-Vibe-Amir
authored
Complete README update
Added full project structure, usage, CI/CD info, and author details.
1 parent 204e96b commit 7606c17

1 file changed

Lines changed: 63 additions & 0 deletions

File tree

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,66 @@ This project is designed to demonstrate the basics of containerization and autom
77

88
## 📁 Project Structure
99

10+
hello-docker/
11+
├── app.py # Simple Python script
12+
├── Dockerfile # Docker instructions
13+
├── .github/workflows/ci.yml # GitHub Actions workflow
14+
└── README.md # Project documentation
15+
16+
yaml
17+
Copy
18+
Edit
19+
20+
---
21+
22+
## 🚀 How to Run the App
23+
24+
### Using Docker:
25+
26+
```bash
27+
docker build -t hello-docker .
28+
docker run hello-docker
29+
✅ Output:
30+
31+
css
32+
Copy
33+
Edit
34+
Hello from inside a Docker container!
35+
⚙️ CI/CD with GitHub Actions
36+
This project uses GitHub Actions for continuous integration.
37+
38+
On every push or pull request to the main branch:
39+
40+
✅ Code is checked out
41+
42+
🐍 Python 3.10 is set up
43+
44+
▶️ Python script (app.py) is executed
45+
46+
💡 You can view the status and logs in the "Actions" tab of this repository.
47+
48+
📚 What I Learned
49+
Docker basics: writing a Dockerfile, building and running containers
50+
51+
Using GitHub Actions for CI pipelines
52+
53+
Automating Python project testing and execution
54+
55+
Structuring DevOps-ready repositories
56+
57+
🔗 Useful Commands
58+
Build Docker image:
59+
60+
bash
61+
Copy
62+
Edit
63+
docker build -t hello-docker .
64+
Run the container:
65+
66+
bash
67+
Copy
68+
Edit
69+
docker run hello-docker
70+
🧑‍💻 Author
71+
Syntax-Vibe-Amir
72+
GitHub: github.com/Syntax-Vibe

0 commit comments

Comments
 (0)