55f2e020b5
* Add dark/light theme toggle feature * update: refine dark/light theme and related components * 调整语义化主题变量，优化暗/亮模式切换效果 * Revert "调整语义化主题变量，优化暗/亮模式切换效果" This reverts commit 85d9373297686fdbacb252a880b2847d20a39641. * 深色模式适配：减少 !important，迁移 CSS 变量，优化布局 * style: 替换硬编码颜色值为CSS变量以支持主题切换 将多处硬编码的颜色值（如#fff、#f0f0f0等）替换为CSS变量（如--gray-0、--gray-150等），统一管理颜色样式，便于主题切换和样式维护。主要修改包括背景色、边框色、文字色等视觉元素，同时移除不再需要的深色模式适配代码。 * style: 使用CSS变量替换硬编码颜色值 * refactor(theme): 重构主题系统，统一使用CSS变量并优化暗色模式实现 - 移除冗余的theme.js配置文件，将主题配置集中到theme store - 使用ant-design-vue的darkAlgorithm实现暗色模式 - 在多个组件中替换硬编码颜色值为CSS变量 - 优化用户信息组件，整合文档中心和主题切换功能 - 更新基础CSS样式，完善颜色系统和滚动条样式 * reset: 恢复被覆盖的修改（96d257a7ace38c94e2b113d56472d211d1141087） * feat(theme): 实现深色主题支持并重构样式系统 重构颜色变量系统，添加深色主题支持 移除硬编码颜色值，统一使用CSS变量 优化图表组件以响应主题切换 清理无用样式代码，提升可维护性 * docs: 更新开发规范文档 * style: 调整边框和背景颜色样式 --------- Co-authored-by: Wenjie Zhang <xerrors@163.com>
33 lines
2.2 KiB
Markdown
33 lines
2.2 KiB
Markdown
|
||
# 项目目录结构 (Project Overview)
|
||
|
||
Yuxi-Know 是一个基于知识图谱和向量数据库的智能知识库系统。它通过 FastAPI 提供后端 API，使用 Vue.js 构建前端界面，并利用 Docker Compose 进行整体服务的编排和管理。
|
||
|
||
文档中心在 `docs` 文件夹下面。
|
||
|
||
## 开发与调试工作流 (Development & Debugging Workflow)
|
||
|
||
本项目完全通过 Docker Compose 进行管理。所有开发和调试都应在运行的容器环境中进行。使用 `docker compose up -d` 命令进行构建和启动。
|
||
|
||
核心原则: 由于 api-dev 和 web-dev 服务均配置了热重载 (hot-reloading)，本地修改代码后无需重启容器，服务会自动更新。应该先检查项目是否已经在后台启动（`docker ps`），查看日志（`docker logs api-dev --tail 100`）具体的可以阅读 [docker-compose.yml](docker-compose.yml).
|
||
|
||
前端开发规范：
|
||
|
||
- API 接口规范：所有的 API 接口都应该定义在 web/src/apis 下面，并继承自 apiGet/apiPost/apiRequest 以及其他。
|
||
- Icon 应该从 @ant-design/icons-vue 或者 lucide-vue-next （推荐，但是需要注意尺寸）
|
||
- Vue 中的样式使用 less，非必要情况必须使用[base.css](web/src/assets/css/base.css) 中的颜色变量。
|
||
- UI风格要简洁，同时要保持一致性，颜色要尽量参考 不要悬停位移，不要过度使用阴影以及渐变色。
|
||
- 绝对不要尝试使用 npm/pnpm 等等运行前端开发服务器。
|
||
|
||
|
||
后端开发规范：
|
||
|
||
- 项目使用 uv 来管理依赖，所以必须使用 uv run 来调试。
|
||
- Python 代码要符合 Python 的规范，符合 pythonic 风格，尽量使用较新的语法，避免使用旧版本的语法（版本兼容到 3.12+），使用 make lint 检查 lint。使用 make format 来格式化代码。
|
||
|
||
其他：
|
||
|
||
- 如果需要新建说明文档（仅开发者可见，非必要不创建），则保存在 `docs/vibe` 文件夹下面
|
||
- 测试脚本可以放在 test 文件夹下面，可以从 docker 中启动测试（不要使用本地 Python 环境）
|
||
- 代码更新后要检查文档部分是否有需要更新的地方，文档的目录定义在 `docs/.vitepress/config.mts` 中。文档应该更新最新版（`docs/latest`）
|