Stooland Docs

Appearance

Stooland2 全栈开发配置（迁移自 web/DEVELOPMENT_CONFIG.md） ​

本文档统一记录前后端项目结构、开发环境、工作流、接口规范、调试与部署配置，以及常用命令与注意事项，便于团队协作与维护。

项目结构 ​

  • 前端：web/（Vue3 + Vite）
  • 后端：api/（ThinkPHP8 + MySQL）
  • 文档：docs/（API、产品、业务、架构、约定、ADR、运营）

开发环境与工作区 ​

  • VS Code 工作区：stooland-fullstack.code-workspace
  • 新增 📚 Docs 入口，统一检索与预览

前端（web） ​

  • 技术栈：Vue3、Vite、Vue Router、Vuex、Element Plus、SCSS、Tailwind（可选）、iconfont
  • 目录结构：src/ 下包含 views/、router/、store/、api/、utils/ 等
  • 运行与构建：npm run dev / npm run build / npm run preview
  • 权限与调试：src/permission.js 路由守卫与角色鉴权；import.meta.env.DEV 开发模式开关

后端（api） ​

  • 技术栈：ThinkPHP8、MySQL
  • API 文档：docs/api/openapi.yaml（OpenAPI 3）与 docs/api/README.md
  • 模块：管理员、智能体、AIGC、文章、素材、会员、消息、任务等
  • 调试：Postman/REST Client；建议与 OpenAPI 生成 mock/测试用例

接口开发规范（摘要） ​

  • 路由约定：RESTful 风格，资源命名统一，批量与状态变更采用动词后缀
  • 请求与响应：统一返回结构，包含 code、message、data
  • 认证与鉴权：Token/Session，角色与权限校验在后端中间件实现
  • 错误码与异常：定义业务错误码表，统一异常处理与日志记录

调试与配置 ​

  • 环境变量：VITE_BASE_API、VITE_QINIU_IMAGE_HOST、VITE_AZURE_AUDIO_KEY、VITE_AZURE_AUDIO_AREA 等
  • 本地调试：前端 npm run dev，后端本地服务与数据库配置；可使用 docs/operations/README.md 中的启动与监控指引

部署与运维 ​

  • 构建产物：前端静态资源，后端部署包
  • 日志与监控：统一日志格式，接入监控/告警；参考 docs/operations/README.md
  • 灰度与回滚：版本标识与变更记录；关键架构变更记录在 docs/adr/

常用命令 ​

  • 安装依赖：npm i
  • 开发：npm run dev
  • 构建：npm run build
  • 预览：npm run preview

重要注意事项 ​

  • 文档统一入口在 docs/，原来 web/DEVELOPMENT_CONFIG.md 已迁移至此文件
  • 如需更新接口或约定，请同时更新 docs/api/openapi.yaml 与 docs/conventions/trae.md