demo_docs/Readme.md

62 lines
2.3 KiB
Markdown

### Đề xuất
- Nên Clone về máy và Import vào Obsidian để xem
- Link Obsidian: [Obsidian](https://obsidian.md/download)
### Tổng quan về dự án
- Giới thiệu tổng quan về dự án: [Zee]
- Knowledge Base: Knowledge Base Folder
- Tài liệu theo quy trình [[Tài liệu theo Workflow]]
- Tài liệu theo Vai trò [[Tài liệu theo Role]]
- Hướng dẫn cho người mới : Guidelines Folder, Sample Folder
- Mẫu cấu trúc: Template Folder
- Diagram: [[Diagrams CICD]], [[Diagram Image]]
### Tổng quan về kiến trúc
- Sử dụng Mô hình DDD (Domain Driven Development) - Customize
- `Resource`: Các Aggregate DDD
- `Transaction`: Các Saga điều phối luồng nghiệp vụ phức tạp
- `Adapter`: Xử lý giao tiếp với các hệ thống bên ngoài
- `Helper`: Các thư viện, tiện ích dùng chung
- `UIUX`: Lớp giao diện người dùng
- Thành phần kiến trúc chi tiết (U-Hierarchy)
- `ubit`: Đơn vị logic nhỏ nhất (hàm, type, hằng số)
- `ubrick`: Tập hợp các `ubit` liên quan
- `ublock`: Thành phần hoạt động độc lập tương đối
- `ubundle`: Tính năng hoàn chỉnh cho người dùng
### Techstack
- Frontend: Thiết kế giao diện theo Framework
- Framework: Vue (Nuxtjs), Flutter (Mobile)
- Css Framework: TailwindCss
- Helper Color generation: UL Color Schema
- CMS Framework: .....
- Database: Postreql, Mongodb, ....
- CI/CD Workflow:
- Git Server: Gitea
- Runner: Gitea Runner
- Workflow Action: Gitea Action
- Server: VPS, Cloud Service(AWS, GCP, Azure)
- Artifact Management: Gitea Packages, Nexus, Docker
- Secret Management: Gitea Secret
- Containerization: Kubernetes, Docker
- Feature Flag: Go Feature Flag, Unleash Selfhosted
- *Logging: Loki + Grafana (Soon)*
- *Monitoring: Grafana(Soon)*
- *Alerting: Telegram(Soon)*
- *Infra as Code: Ansible, OpenTofu (Soon)*
- Backend:
- Ngôn ngữ: Golang, Nodejs
- ORM: https://gorm.io/
- Web Framework: https://gin-gonic.com/
- API Document: https://swagger.io/
### Thư viện ngôn ngữ
- Library Golang [[Thư viện cho Golang]]
- Library Nodejs [[Thư viện cho Nodejs]]
### Thông tin liên hệ & Contact
- Kênh chính: Google Docs
- Kênh Chat: Telegram | Discord
- Lưu trữ dữ liệu: Obsidiant, Google Drive
- Meeting: Discord