mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-04-29 02:46:25 +02:00
feat: initialize agent and claude skill libraries with comprehensive knowledge bases, workflow templates, and implementation artifacts.
This commit is contained in:
parent
956d8c6322
commit
b35b4337bb
2028 changed files with 565614 additions and 0 deletions
32
docs/source-tree-analysis.md
Normal file
32
docs/source-tree-analysis.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Báo Cáo Source Tree (Monorepo)
|
||||
|
||||
## 1. Cấu trúc Root (Monorepo)
|
||||
Dự án SurfSense sử dụng mô hình Monorepo (quản lý ở cấp độ thư mục gốc) chứa tất cả Client và Backend, giúp dễ dàng chia sẻ Scripts và Docker Configurations. Cấu trúc gồm 4 cột trụ chính và các files bổ trợ:
|
||||
|
||||
```text
|
||||
SurfSense/
|
||||
├── .agent/ # Cấu hình BMad Framework (Agent settings, prompts)
|
||||
├── .github/ # GitHub Actions CI/CD workflows
|
||||
├── _bmad/ # Dữ liệu phục vụ BMAD chạy nội bộ
|
||||
├── _bmad-output/ # Nơi lưu kết quả, sprints, architect docs của BMAD
|
||||
├── docker/ # Nơi chứa config deploy Docker & Compose
|
||||
├── docs/ # [Mục lục này] Output docs đã generate/review
|
||||
├── scripts/ # Bash scripts để setup, format, chạy tools cục bộ
|
||||
├── surfsense_backend/ # Core FastAPI, Python Codebase
|
||||
├── surfsense_browser_extension/ # Extension build folder
|
||||
├── surfsense_desktop/ # Native Web-wrappers Desktop / Electron-Tauri
|
||||
└── surfsense_web/ # Next.js Web App Core
|
||||
```
|
||||
|
||||
## 2. Chi Tiết Từng Phân Hệ Core
|
||||
|
||||
### 2.1 Backend (`surfsense_backend`)
|
||||
Bao gồm App FastAPI có cấu trúc Layered Architecture cổ điển. Python version yêu cầu 3.12+. Dependency được quản lý qua `poetry` hoặc `requirements.txt`. (Chi tiết tại `architecture-backend.md`).
|
||||
|
||||
### 2.2 Frontend Web (`surfsense_web`)
|
||||
Bao gồm một lượng lớn UI/UX logic bằng NextJS 16 App Router. Đi kèm với nó là Setup Shadcn UI tĩnh. (Chi tiết tại `architecture-web.md`).
|
||||
|
||||
### 2.3 Phân hệ Setup Nội Bộ
|
||||
- `.secrets.baseline`: Công cụ phát hiện secret rò rỉ (Yelp detect-secrets).
|
||||
- `.pre-commit-config.yaml`: Các pre-commit hooks khi lập trình viên submit code (biome, ruff...).
|
||||
- `biome.json`: Sử dụng BiomeJS làm Formatter / Linter chính thay thế cho Prettier/ESLint cho Frontend nhằm đem lại hiệu năng vượt trội.
|
||||
Loading…
Add table
Add a link
Reference in a new issue