Frappe PDM Tutorial

A beginner-friendly, project-based Frappe Framework course for building a mini PDM (Product Data Management) system.

This repository is organized as a bilingual open-source tutorial:

• English: docs/en
• 中文版: docs/zh

The course teaches Frappe through a practical mini PDM project covering DocType modeling, parent-child tables, permissions, workflow, controller logic, client scripts, Query Reports, REST API, tests, fixtures, and delivery checklists.

Who This Is For

• Junior developers learning Frappe or ERPNext.
• ERP implementation consultants moving toward technical delivery.
• Business analysts who want to understand metadata-driven enterprise systems.
• Teams preparing internal Frappe training.

Repository Structure

frappe-pdm-tutorial/
├── README.md
├── LICENSE
├── LICENSE-CODE-MIT
├── CONTRIBUTING.md
├── CHANGELOG.md
├── SECURITY.md
├── .gitignore
├── .github/
│   ├── ISSUE_TEMPLATE/
│   │   ├── bug_report.md
│   │   └── content_improvement.md
│   └── PULL_REQUEST_TEMPLATE.md
└── docs/
    ├── en/
    │   ├── README.md
    │   ├── BEGINNER_GUIDE.md
    │   ├── LECTURE_NOTES.md
    │   ├── PROJECT_SPEC.md
    │   ├── PRACTICAL_LABS.md
    │   ├── CODE_SNIPPETS.md
    │   ├── ANTI_PATTERNS.md
    │   ├── TEACHER_GUIDE.md
    │   └── FINAL_DELIVERY_CHECKLIST.md
    └── zh/
        ├── README.md
        ├── BEGINNER_GUIDE.md
        ├── LECTURE_NOTES.md
        ├── PROJECT_SPEC.md
        ├── PRACTICAL_LABS.md
        ├── CODE_SNIPPETS.md
        ├── ANTI_PATTERNS.md
        ├── TEACHER_GUIDE.md
        └── FINAL_DELIVERY_CHECKLIST.md

License

This repository uses a dual-license model:

• Documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).
• Code snippets in CODE_SNIPPETS.md are licensed under the MIT License.

In short: you may use, share, adapt, and teach from the documentation as long as you give attribution and share adapted documentation under the same license. You may use the code snippets freely under MIT terms.

中文说明

这是一个中英双语的 Frappe/PDM 教程仓库。英文作为主入口，中文完整版本位于 docs/zh。

许可采用双协议：

• 文档部分：CC BY-SA 4.0
• CODE_SNIPPETS.md 中的代码片段：MIT

Roadmap

Contributions are welcome. If you find a missing topic, unclear explanation, better example, or useful teaching material, feel free to open an issue or pull request.

• Add screenshots
• Add runnable sample Frappe app
• Add Docker-based setup guide
• Add GitHub Pages documentation site
• Add video walkthrough
• Add advanced architecture module

路线图

欢迎大家一起补充和参与。如果你发现缺少的主题、不够清楚的解释、更好的示例或有价值的教学材料，欢迎提交 issue 或 pull request。

• 补充截图
• 增加可运行的 Frappe 示例 App
• 增加基于 Docker 的环境搭建指南
• 发布 GitHub Pages 文档站
• 增加视频讲解
• 增加高级架构模块

Project Maintenance

• Changes are tracked in CHANGELOG.md.
• Security guidance is documented in SECURITY.md.
• Contributions are described in CONTRIBUTING.md.
• GitHub issue and pull request templates are included under .github/.