Doppio 项目安装与使用指南

Doppio 项目安装与使用指南

doppio A Frappe app (CLI) to magically setup single page applications and Vue/React powered desk pages on your custom Frappe apps. 项目地址: https://gitcode.com/gh_mirrors/dopp/doppio

1. 项目目录结构及介绍

Doppio 项目的目录结构如下：

doppio/
├── doppio/
│   ├── libs/
│   ├── gitignore
│   ├── MANIFEST.in
│   ├── README.md
│   ├── license.txt
│   ├── package-lock.json
│   ├── package.json
│   ├── requirements.txt
│   ├── setup.py
│   └── yarn.lock
├── vscode/
└── README.md

目录结构介绍

• doppio/: 主项目目录，包含所有核心代码和配置文件。
  • libs/: 存放项目依赖库的目录。
  • gitignore: Git 忽略文件配置。
  • MANIFEST.in: Python 包的清单文件。
  • README.md: 项目说明文档。
  • license.txt: 项目许可证文件。
  • package-lock.json: 锁定 npm 包版本的文件。
  • package.json: npm 包配置文件。
  • requirements.txt: Python 依赖包列表。
  • setup.py: Python 项目安装脚本。
  • yarn.lock: 锁定 Yarn 包版本的文件。
• vscode/: 可能包含 VSCode 相关配置文件。
• README.md: 项目说明文档。

2. 项目启动文件介绍

Doppio 项目的启动文件主要是 setup.py 和 package.json 中的脚本。

setup.py

setup.py 是 Python 项目的安装脚本，用于配置和安装项目所需的 Python 包。通常在项目根目录下运行以下命令来安装依赖：

pip install -r requirements.txt

package.json

package.json 是 npm 包配置文件，包含了项目的元数据和脚本命令。以下是一些常用的脚本命令：

• dev: 启动开发服务器。
• build: 构建生产环境的应用。

例如，启动开发服务器可以使用以下命令：

yarn dev

3. 项目配置文件介绍

Doppio 项目的主要配置文件包括 package.json 和 requirements.txt。

package.json

package.json 包含了项目的元数据和脚本命令。以下是一些重要的配置项：

• name: 项目名称。
• version: 项目版本。
• scripts: 定义了项目的脚本命令，如 dev 和 build。
• dependencies: 项目依赖的 npm 包列表。
• devDependencies: 开发环境依赖的 npm 包列表。

requirements.txt

requirements.txt 列出了项目所需的 Python 依赖包及其版本。通常在项目根目录下运行以下命令来安装这些依赖：

pip install -r requirements.txt

通过以上配置文件，可以方便地管理和安装项目所需的依赖，确保项目能够正常运行和构建。

doppio A Frappe app (CLI) to magically setup single page applications and Vue/React powered desk pages on your custom Frappe apps. 项目地址: https://gitcode.com/gh_mirrors/dopp/doppio