mcpField
F
frappe-app-dev

frappe-app-dev

github.com/frappe开发1591.2k 次安装2 天前更新
代码仓库

关于 frappe-app-dev

frappe-app-dev 是帮助开发者创建或扩展 Frappe 全栈应用的技能。它按任务选择对应流程和参考文档,并规定 bench、站点和开发操作的执行方式。

主要功能

  1. 01区分新应用与现有应用开发流程
  2. 02按任务读取相关参考文档
  3. 03提供站点、DocType 与控制器开发指引
  4. 04涵盖 API、数据库、权限和测试
  5. 05规定 bench 命令的执行方式

适用场景

  1. 01从头搭建 Frappe 应用
  2. 02为现有 Frappe 应用添加功能
  3. 03实现 DocType、API 或后台任务
  4. 04管理 Frappe 站点并运行测试

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/frappe/skills --skill frappe-app-dev

安装后在 Claude Code 中输入/frappe-app-dev确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
api.md
background-jobs.md
bench-operations.md
caching.md
controllers.md
database.md
doctypes.md
existing-app.md
frontend-desk.md
frontend-portal.md
frontend-vue.md
frontend.md
hooks.md
new-app.md
permissions.md
realtime.md
site-management.md
testing.md

详细介绍

Frappe 全栈应用构建器

全局规则

  • 使用裸命令 bench。不要使用 ./env/bin/bench,也不要使用完整路径。
  • 不要运行 which bench、bench --version、bench --help,也不要检查 frappe 版本。不要运行任何探查命令。
  • 不要将检测 bench 的工作委派给子 Agent。请自行运行 ls apps/ sites/ Procfile。
  • 不要使用 mkdir 创建 DocType 文件夹。Frappe 会通过 bench migrate 创建这些文件夹。
  • 仅在后台进程中运行 bench start。
  • 运行 bench start 前,检查是否已在现有终端中运行。不要启动第二个实例。
  • 始终为 bench 命令显式传入 --site <site>。绝不要直接运行 bench migrate。

流程选择

确定适用的流程,然后只阅读相关文件:

创建全新应用

阅读 new-app.md — 涵盖 bench 设置、应用脚手架搭建、站点创建和安装。

使用现有应用

阅读 existing-app.md — 涵盖查找 bench、定位应用、确认站点和扩展功能。

功能参考

仅加载当前任务所需的参考资料:

主题加载时机文件
站点管理查找、创建或管理站点site-management.md
DocTypes创建或修改 DocType、字段和命名doctypes.md
控制器文档生命周期、服务器逻辑controllers.md
白名单 APIREST 端点、@frappe.whitelist()api.md
数据库与 ORMfrappe.db、查询、原始 SQLdatabase.md
缓存Redis、frappe.cachecaching.md
实时功能WebSocket、publish_realtimerealtime.md
后台任务frappe.enqueue、计划任务background-jobs.md
Hookshooks.py 模式hooks.md
权限角色、DocType 权限、has_permissionpermissions.md
测试编写和运行测试testing.md
前端与 UIDesk UI、Vue SPA、门户页面frontend.md(路由 → 3 个子文件)
Bench CLI所有 bench 命令参考bench-operations.md

评论

支持 Markdown