Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,102 @@

<p align="center">
<img src="public/gitbot-logo.svg" alt="GitBot logo" width="112" height="112" />
</p>

<h1 align="center">GitBot</h1>

<p align="center">
Nền tảng tự động hóa Pull Request, CI/CD và tài liệu vận hành dành cho đội kỹ thuật hiện đại.
</p>

<p align="center">
<a href="#-tổng-quan">Tổng quan</a> ·
<a href="#-tính-năng-chính">Tính năng</a> ·
<a href="#-kiến-trúc">Kiến trúc</a> ·
<a href="#-chạy-cục-bộ">Chạy cục bộ</a> ·
<a href="#-triển-khai-vercel">Vercel</a>
</p>

---

## ✨ Tổng quan

**GitBot** là giao diện quản trị giúp nhóm phát triển theo dõi toàn bộ vòng đời Pull Request trong một workspace thống nhất: review diff, bình luận theo dòng, quan sát pipeline, đọc wiki nội bộ và kiểm tra readiness trước khi deploy.

Thiết kế dự án tập trung vào ba nguyên tắc:

- **Tối giản:** thông tin quan trọng được ưu tiên, ít nhiễu thị giác.
- **Hiện đại:** dark UI cho app vận hành, wiki sáng sạch theo phong cách documentation hub.
- **Thực dụng:** mọi màn hình đều phục vụ trực tiếp cho review, CI/CD, bảo mật và rollout.

## 🚀 Tính năng chính

| Khu vực | Mô tả |
| --- | --- |
| Wiki | Trang giới thiệu tài liệu, mục lục, hướng dẫn CI/CD và checklist release. |
| Dashboard | KPI repository, PR, pipeline, diff stats và tín hiệu hệ thống. |
| Code Review | Xem diff, chọn file, gửi bình luận theo ngữ cảnh PR. |
| Pipeline | Theo dõi stage lint/test/build/deploy và trạng thái workflow. |
| Mobile Simulator | Kiểm tra trải nghiệm GitBot trên khung di động mô phỏng. |
| Command Palette | Điều hướng nhanh bằng `⌘K` / `Ctrl K`. |

## 🧭 Kiến trúc

```mermaid
flowchart LR
GitHub[GitHub Webhook] --> API[GitBot API]
API --> Runner[GitBot Runner]
API --> DB[(PostgreSQL)]
Runner --> CI[CI/CD Jobs]
API --> UI[React Workspace]
UI --> Wiki[Wiki & Dashboard]
```

## 🧩 Logo

Logo GitBot sử dụng biểu tượng robot kết hợp nhánh Git để thể hiện vai trò trợ lý tự động hóa kỹ thuật. Bảng màu xanh `sky` và `emerald` đồng bộ với giao diện sản phẩm, gợi cảm giác đáng tin cậy, realtime và thân thiện với developer.

- File logo: [`public/gitbot-logo.svg`](public/gitbot-logo.svg)
- Có thể dùng trực tiếp cho GitHub README, header web app, favicon hoặc tài liệu nội bộ.

## 🛠 Chạy cục bộ

```bash
npm install
npm run dev
```

Ứng dụng mặc định chạy tại:

```txt
http://localhost:3000
```

## 📦 Build production

```bash
npm run build
npm run start
```

## ▲ Triển khai Vercel

Dự án đã chuẩn bị UI và build Vite phù hợp cho triển khai production. Khi môi trường có quyền registry và token Vercel, có thể deploy bằng:

```bash
npx vercel --prod --yes
Comment thread
Huynhthuongg marked this conversation as resolved.
```

## 📚 Tài liệu trong app

Mở ứng dụng và chọn tab **Wiki** để xem trang giới thiệu tài liệu được thiết kế riêng cho GitBot, bao gồm:

1. Tổng quan dự án.
2. Bắt đầu nhanh.
3. Cấu hình `.gitbot-ci.yml` mẫu.
4. Quy ước review và release.
5. Checklist triển khai Vercel.

## 📄 License

Apache-2.0
Loading