Doppio 项目使用指南
1. 项目介绍
Doppio 是一个 Frappe 应用(CLI),旨在为您的自定义 Frappe 应用轻松设置单页应用程序(SPA)和使用 Vue/React 驱动的桌面页面。通过 Doppio,您可以快速搭建基于 Vue 3 或 React 的单页应用程序,并将其集成到您的 Frappe 应用中。
2. 项目快速启动
安装
首先,在您的 Frappe 工作目录中执行以下命令来安装 Doppio 应用:
bench get-app https://github.com/NagariaHussain/doppio.git
设置 Vue/React SPA
要设置一个新的单页应用程序,您可以在 Frappe 工作目录中运行以下命令:
bench add-spa --app <app-name> [--tailwindcss] [--typescript]
或者,您可以直接运行以下命令并根据提示进行操作:
bench add-spa
在提示中,您需要输入单页应用程序的名称,选择框架(React 或 Vue),以及是否使用 TypeScript 或 JavaScript。您还可以选择是否使用 TailwindCSS。
启动开发服务器
设置完成后,进入 SPA 目录并启动开发服务器:
cd <your-spa-name>
yarn dev
开发服务器默认在端口 8080 上运行,您可以在浏览器中访问 <site>:8080
查看运行中的应用程序。
3. 应用案例和最佳实践
应用案例
Doppio 可以用于快速搭建企业内部管理系统的单页应用程序,例如:
- 仪表盘:使用 Vue 3 或 React 构建一个实时数据展示的仪表盘。
- 自定义桌面页面:为 Frappe 应用添加自定义的桌面页面,提升用户体验。
最佳实践
- 模块化开发:将不同的功能模块化,便于维护和扩展。
- 使用 TypeScript:在大型项目中使用 TypeScript 可以提高代码的可维护性和可读性。
- 集成 TailwindCSS:使用 TailwindCSS 可以快速构建美观的 UI,减少样式代码的编写。
4. 典型生态项目
Frappe Framework
Frappe Framework 是一个开源的 Web 应用框架,Doppio 是基于 Frappe 框架开发的,因此与 Frappe 框架紧密集成。
Vite
Doppio 使用 Vite 作为前端构建工具,Vite 是一个快速的构建工具,特别适合现代 JavaScript 框架(如 Vue 和 React)的开发。
Frappe-React-SDK
如果您选择使用 React,Doppio 会自动配置 Frappe-React-SDK,这是一个用于与 Frappe 后端进行交互的 SDK。
通过以上步骤,您可以快速上手并使用 Doppio 项目,为您的 Frappe 应用添加现代化的单页应用程序。