-
-
Notifications
You must be signed in to change notification settings - Fork 2
Update README.md #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update README.md #16
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ``` | ||
|
|
||
| ## 📚 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 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.