KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #claude-code #codex #developer-tools #dsh-plugin #deepseek-harness #windows #open-source #agent-skills #ai

Class_CI-CD

★ 110 Open GitHub ↗

🤖 CI/CD pipeline tutorial using GitHub Actions — covering automated build, test, and deployment workflows for modern web applications.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🤖 Class CI/CD — PM2 · Docker · GitHub Actions · VPS

> Khóa học thực hành xây dựng pipeline CI/CD hoàn chỉnh từ đầu —  
> từ tự động hóa deploy bằng PM2 đến containerize với Docker và nhận thông báo qua Telegram.

![CI/CD](https://img.shields.io/badge/CI%2FCD-GitHub%20Actions-2088FF?style=flat-square&logo=githubactions&logoColor=white)
![Node.js](https://img.shields.io/badge/Node.js-20-339933?style=flat-square&logo=nodedotjs&logoColor=white)
![Docker](https://img.shields.io/badge/Docker-Compose-2496ED?style=flat-square&logo=docker&logoColor=white)
![PM2](https://img.shields.io/badge/PM2-Process%20Manager-2B037A?style=flat-square&logo=pm2&logoColor=white)
![VPS](https://img.shields.io/badge/Self--hosted-VPS-FF6600?style=flat-square&logo=linux&logoColor=white)

---

## 📋 Mục lục

- [Giới thiệu](#-giới-thiệu)
- [Kiến trúc Pipeline](#-kiến-trúc-pipeline)
- [Tech Stack](#-tech-stack)
- [Cấu trúc dự án](#-cấu-trúc-dự-án)
- [Yêu cầu](#-yêu-cầu)
- [Hướng dẫn cài đặt](#-hướng-dẫn-cài-đặt)
- [Chạy với Docker](#-chạy-với-docker)
- [API Endpoint](#-api-endpoint)
- [Liên hệ](#-liên-hệ)

---

## 🎯 Giới thiệu

Dự án này là tài liệu học thực hành về **CI/CD (Continuous Integration / Continuous Deployment)**. Bạn sẽ được học cách:

- Thiết lập **self-hosted GitHub Actions runner** trên VPS
- Tự động deploy ứng dụng Node.js bằng **PM2**
- Containerize ứng dụng với **Docker** và **Docker Compose**
- Nhận thông báo deploy qua **Telegram Bot**
- Quản lý biến môi trường an toàn bằng **GitHub Secrets**

---

## 🏗 Kiến trúc Pipeline

Ba luồng CI/CD được trình bày trong khóa học:

### 1. CI/CD với PM2

```
Push Code → GitHub Actions → SSH vào VPS → Pull Code → PM2 Restart
```

![Diagram PM2](https://raw.githubusercontent.com/fdhhhdjd/Class_CI-CD/main/assets/diagram1.png)

### 2. CI/CD với Docker

```
Push Code → GitHub Actions → Build Docker Image → Push Registry → VPS Pull & Run
```

![Diagram Docker](https://raw.githubusercontent.com/fdhhhdjd/Class_CI-CD/main/assets/diagram.png)

### 3. CI/CD với Docker + Telegram Notification

```
Push Code → GitHub Actions → Build & Deploy Docker → Telegram Bot thông báo kết quả
```

![Diagram Docker + Telegram](https://raw.githubusercontent.com/fdhhhdjd/Class_CI-CD/main/assets/diagram3.png)

---

## 🛠 Tech Stack

| Công nghệ | Mục đích |
|---|---|
| **Node.js 20** | Runtime ứng dụng |
| **Express.js** | HTTP framework |
| **Docker / Docker Compose** | Containerization |
| **PM2** | Process manager trên VPS |
| **GitHub Actions** | CI/CD pipeline |
| **Self-hosted Runner** | Deploy lên VPS thực tế |
| **Telegram Bot API** | Thông báo deploy |
| **dotenv** | Quản lý biến môi trường |

---

## 📁 Cấu trúc dự án

```
Class_CI-CD/
├── .github/
│   ├── workflows/
│   │   └── cicd-workflow.yml     # GitHub Actions workflow
│   └── scripts/                  # Helper scripts
├── assets/
│   ├── diagram.png               # Sơ đồ CI/CD với Docker
│   ├── diagram1.png              # Sơ đồ CI/CD với PM2
│   └── diagram3.png              # Sơ đồ CI/CD với Docker + Telegram
├── Dockerfile                    # Build image Node.js 20 Alpine
├── docker-compose.yml            # Cấu hình multi-container
├── makefile                      # Lệnh Docker tiện dụng
├── server.js                     # Ứng dụng Express chính
├── package.json
├── CI-CD.md                      # Hướng dẫn thiết lập chi tiết
└── DIAGRAM.md                    # Tài liệu sơ đồ kiến trúc
```

---

## ✅ Yêu cầu

- **Node.js** >= 20
- **Docker** & **Docker Compose**
- **VPS** (Ubuntu/Debian) với SSH access
- Tài khoản **GitHub** (để cấu hình Actions & Secrets)
- **PM2** (cài global: `npm install -g pm2`)

---

## 🚀 Hướng dẫn cài đặt

### 1. Clone repository

```bash
git clone git@github.com:fdhhhdjd/Class_CI-CD.git
cd Class_CI-CD
```

### 2. Cài đặt dependencies

```bash
npm install
```

### 3. Tạo file `.env`

```env
PORT=5000
```

### 4. Chạy với PM2 (development)

```bash
pm2 start server.js --name=class_cicd
pm2 save
pm2 startup
```

### 5. Thiết lập Self-hosted Runner trên VPS

```bash
# Tạo thư mục runner
mkdir actions-runner && cd actions-runner

# Cấu hình runner (lấy token từ repo Settings > Actions > Runners)
./config.sh --url https://github.com/fdhhhdjd/Class_CI-CD --token <YOUR_TOKEN>

# Chạy runner như service
./svc.sh install
./svc.sh start
```

### 6. Cấu hình GitHub Secrets

Vào **Settings → Secrets and variables → Actions**, thêm các secret:

| Secret | Mô tả |
|---|---|
| `SSH_PRIVATE_KEY` | Private key để SSH vào VPS |
| `VPS_HOST` | IP hoặc domain của VPS |
| `VPS_USER` | Username SSH |
| `TELEGRAM_TOKEN` | Token Telegram Bot |
| `TELEGRAM_CHAT_ID` | Chat ID nhận thông báo |

---

## 🐳 Chạy với Docker

```bash
# Build và start container
make run-build

# Dừng container
make run-down
```

Hoặc dùng Docker Compose trực tiếp:

```bash
docker-compose up -d --build
docker-compose down
```

> Health check tự động ping `GET /ci-cd` mỗi 60 giây để đảm bảo container hoạt động ổn định.

---

## 📡 API Endpoint

| Method | Endpoint | Mô tả |
|---|---|---|
| `GET` | `/ci-cd` | Health check — kiểm tra server hoạt động |

**Response mẫu:**

```json
{
  "status": 200,
  "message": "CI-CD By Nguyen Tien Tai Ok 🤖"
}
```

---

## 📞 Liên hệ

Có thắc mắc hoặc muốn học thêm về Web, AI Automation, Interview?

| Kênh | Thông tin |
|---|---|
| 📧 Email | nguyentientai10@gmail.com |
| 📱 Zalo / Hotline | 0798 805 741 |
| 🌐 Website | [codewebkhongkho.com](https://codewebkhongkho.com) |

---

<div align="center">
  Made with ❤️ by <a href="https://github.com/fdhhhdjd">Nguyen Tien Tai</a>
</div>

Class_CI-CD

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README