Skip to content

Commit 97c9f43

Browse files
committed
Wrote documentation in English and Russian + README.md
1 parent b284100 commit 97c9f43

30 files changed

Lines changed: 1995 additions & 476 deletions

README.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# DevOps Docker Project
2+
3+
A beginner-friendly yet production-grade **CI/CD** demo project using **Docker**, **GitHub Actions**, **Flask**, **Node.js**, and **Nginx**.
4+
5+
---
6+
7+
![CI](https://github.com/Hackitect7/devops-docker-project/actions/workflows/docker-ci.yml/badge.svg) ![Docker Pulls](https://img.shields.io/docker/pulls/hackitect7/flask-api) ![Image Size](https://img.shields.io/docker/image-size/hackitect7/flask-api/latest) ![Last Commit](https://img.shields.io/github/last-commit/Hackitect7/devops-docker-project) ![License](https://img.shields.io/github/license/Hackitect7/devops-docker-project) ![Issues](https://img.shields.io/github/issues/Hackitect7/devops-docker-project)
8+
9+
---
10+
11+
## 🚀 Features
12+
13+
- 🔧 CI/CD pipeline with **GitHub Actions**
14+
- 🐳 Docker-based development and deployment
15+
- 🔁 Reverse proxy with Nginx
16+
- 🐍 Flask backend API
17+
- 🚀 Node.js frontend
18+
- ☁️ Auto-push to **Docker Hub**
19+
20+
---
21+
22+
## ⚡ Quick Start
23+
24+
```bash
25+
git clone https://github.com/Hackitect7/devops-docker-project.git
26+
cd devops-docker-project
27+
sudo docker compose up --build
28+
```
29+
30+
Open in browser:
31+
32+
<http://localhost/api> — Flask API
33+
34+
<http://localhost:3000> — Node.js frontend
35+
36+
<http://localhost> — Nginx reverse proxy (port 80)
37+
38+
To stop services:
39+
40+
```bash
41+
docker compose down
42+
```
43+
44+
## 🧩 Project Structure
45+
46+
```text
47+
/backend - Flask API (Python)
48+
app.py
49+
Dockerfile
50+
51+
/frontend - Node.js frontend
52+
index.js
53+
Dockerfile
54+
55+
/nginx - Nginx config
56+
nginx.conf
57+
Dockerfile
58+
59+
/.github/workflows/docker-ci.yml - CI/CD pipeline
60+
```
61+
62+
## 📚 Documentation
63+
64+
[Documentation in English](./docs/en/SUMMARY.md)
65+
66+
[Documentation in Russian](./docs/ru/SUMMARY.ru.md)
67+
68+
## 📄 License
69+
70+
This project is licensed under the MIT License. See [LICENSE](LICENSE).
71+
72+
## 🤝 Contributing
73+
74+
Pull requests are welcome. For major changes, please open an issue first.See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
75+
76+
## 📬 **Contact Us:**
77+
78+
💼 **LinkedIn:** [https://www.linkedin.com/in/aleksei-polovinkin-918603278/](https://www.linkedin.com/in/aleksei-polovinkin-918603278/)
79+
80+
✉️ **Email:** [papulya2012@gmail.com](mailto:papulya2012@gmail.com)
81+
82+
💬 **Telegram:** [@manfred251278](https://t.me/Manfred251278)

README.md/README.ru.md

Lines changed: 0 additions & 476 deletions
This file was deleted.

docs/en/01_overview.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# 📘 ОПИСАНИЕ ПРОЕКТА
2+
3+
Этот проект демонстрирует реализацию профессионального **CI/CD** пайплайна с использованием **Docker** и **GitHub Actions**.
4+
5+
---
6+
7+
## 🔍 Основные компоненты проекта
8+
9+
Проект включает три контейнеризированных модуля:
10+
11+
- **Backend**: Flask-приложение (Python API)
12+
- **Frontend**: веб-интерфейс на Node.js (Express)
13+
- **Reverse Proxy**: сервер на базе Nginx
14+
15+
---
16+
17+
## 🎯 Цель проекта
18+
19+
Цель — продемонстрировать настройку **автоматической сборки**, **тестирования** и **публикации Docker-образов** в Docker Hub, а также локальный запуск сервисов через Docker Compose.
20+
21+
Проект будет полезен:
22+
23+
- 🔰 **Новичкам** — для изучения **DevOps**-практик, **GitHub Actions** и контейнеризации
24+
- 🧑‍💻 **Специалистам** — как шаблон для построения надёжного и масштабируемого **CI/CD**-процесса

docs/en/02_requirements.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# ⚙️ REQUIREMENTS
2+
3+
For the project to work successfully, you will need:
4+
5+
- 🖥 **Operating system:** Linux, Windows or macOS
6+
7+
- 💾 **Installed software:**
8+
- 🐳 Docker version 20.10 and above
9+
- 📦 Docker Compose version 1.29 and above
10+
- 🔧 Git for working with the repository
11+
12+
- 🔐 SSH client (usually built-in to Linux/macOS, Git Bash is recommended for Windows)
13+
14+
- 👤 **Accounts:**
15+
- ☁️ GitHub account for storing code and CI/CD setup
16+
- 🐋 Docker Hub account for storing Docker images
17+
18+
---
19+
20+
**Recommended versions:**
21+
It is recommended to use the latest stable versions software to avoid compatibility issues.

docs/en/03_quick_start.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# ⚡ QUICK START
2+
3+
To quickly start the project, follow these steps:
4+
5+
📥 **Clone the repository:**
6+
7+
```bash
8+
git clone git@github.com:Hackitect7/devops-docker-project.git
9+
cd devops-docker-project
10+
```
11+
12+
🐳 **Start all services with Docker Compose:**
13+
14+
```bash
15+
sudo docker compose up --build
16+
```
17+
18+
🧪 **Test the applications:**
19+
20+
- 🔗 Backend Flask API: <http://localhost:5000/api>
21+
- 🌐 Frontend Node.js: <http://localhost:3000>
22+
- 🚪 Nginx (reverse proxy): <http://localhost> (port 80)
23+
24+
🛑 **To stop and To remove containers use:**
25+
26+
```bash
27+
sudo docker compose down
28+
```

0 commit comments

Comments
 (0)