3.4 KiB
仓库指南
项目结构与模块划分
本仓库分为 frontend/ 和 backend/ 两部分。业务代码只放在 frontend/src/ 与 backend/src/;dist/、node_modules/ 视为生成产物,不要在里面改业务逻辑。前端主要目录有 src/views/、src/components/、src/api/、src/stores/、src/router/。后端按 Express 常见分层组织:src/routes/、src/controllers/、src/middleware/、src/utils/。数据库结构在 backend/prisma/schema.prisma。
构建、运行与验证命令
cd frontend && npm run dev:启动前端开发服务,默认地址http://localhost:5173cd frontend && npm run build:执行前端类型检查并构建cd backend && npm run dev:启动后端开发服务cd backend && npm run build:编译后端 TypeScriptcd backend && npm run prisma:generate:生成 Prisma Clientcd backend && npm run prisma:migrate:执行本地数据库迁移docker-compose up -d:同时启动 MySQL、后端、前端
代码风格与命名规范
统一使用 TypeScript,缩进保持 2 个空格。Vue 组件使用 PascalCase,例如 EquipmentList.vue;接口模块、工具函数、状态文件使用 camelCase,例如 equipment.ts、format.ts。后端保持“路由进 routes/、处理进 controllers/、公共逻辑进 utils/”的现有结构。Prisma 模型名保持 PascalCase,数据库字段保持 snake_case。
测试与验证要求
当前仓库没有正式的自动化测试体系。每次改动后,至少执行 frontend 和 backend 的构建检查,并手工验证受影响流程,重点关注登录、设备增删改查、借出扫码、归还扫码、统计页面。以后如果补测试,建议放在对应功能旁边或单独的 tests/ 目录,并使用 *.spec.ts 命名。
提交与合并请求规范
当前工作区看不到完整 Git 历史,提交信息建议使用“范围 + 动作”的简短格式,例如:前端:修复借出页跳转、后端:校验设备编码唯一性。每次提交尽量只做一类事情。提交合并请求时,应写明改动范围、是否涉及 Prisma 或环境变量、手工验证步骤;如果改了界面,附截图。
小团队多代理角色
本项目建议使用小团队模式,不要把角色拆得过细。
结构分析代理:只读分析frontend/src、backend/src、backend/prisma,负责找页面入口、接口调用链、控制器位置、数据表关系和影响范围。前端执行代理:只改frontend/,负责页面、表单、路由、状态管理、前端接口接入。后端执行代理:只改backend/src/,负责路由、控制器、中间件、权限和返回结构。数据结构代理:只在确实要改表结构或字段时使用,主要负责backend/prisma和直接相关的后端代码。
本项目的多代理协作规则:
- 跨前后端任务,先让
结构分析代理把调用链和接口契约查清楚,再拆实现。 - 不要让两个执行代理同时改同一层,避免互相覆盖。
- 普通缺陷和页面调整不要动
数据结构代理。 - 最终集成、构建检查和手工验证由主代理负责。
安全与配置提醒
不要提交真实密钥或生产环境配置。后端配置放在 backend/.env,前端配置放在根目录或前端的 Vite 环境文件。共享或部署前,先检查 docker-compose.yml 里的端口和默认账号信息是否适合当前环境。