Frappe ERPNext Shipping 项目启动与配置教程

1. 项目的目录结构及介绍

Frappe ERPNext Shipping 是一个基于 Frappe 框架的开源项目，用于集成 ERPNext 与物流系统。以下是项目的目录结构及各个部分的简要介绍：

erpnext_shipping/
├── apps/                # 存放项目依赖的应用
├── config/              # 配置文件目录
│   ├── __init__.py
│   ├── hooks.py         # 项目钩子文件，用于配置项目特定的设置
│   └──.json             # 配置文件
├── custom_app/          # 自定义应用目录
│   ├── __init__.py
│   └── ...              # 具体应用模块
├── data/                # 静态数据文件，如CSV、JSON等
├── deploy/              # 部署脚本和工具
├── dist/                # 打包后的文件，用于部署
├── environment.py       # 环境变量配置
├── hooks/               # 钩子脚本目录
├── logs/                # 日志文件目录
├── patches/             # 代码补丁目录
├── requirements.txt     # 项目依赖的Python包列表
├── scripts/             # 脚本目录，包括启动脚本
├── sites/               # 站点目录，每个站点有独立的配置和数据
│   └── ...              # 具体站点目录
├── tests/               # 测试代码目录
├── tools/               # 开发工具和脚本
└── version.json         # 项目版本信息

2. 项目的启动文件介绍

项目的启动文件通常位于 scripts 目录下。以下是主要的启动文件及其作用：

• start.py：项目的主要启动脚本，负责初始化应用程序，加载配置，并启动服务。
• restart.sh：用于重启服务的脚本，通常在Linux环境中使用。

启动项目时，可以运行以下命令：

python start.py

或者在Linux环境中，使用重启脚本来重启服务：

./restart.sh

3. 项目的配置文件介绍

项目的配置文件主要位于 config 目录下，以下是几个重要的配置文件：

• hooks.py：项目钩子文件，用于配置项目特定的设置，如自动安装的应用、权限控制等。
• json：项目配置文件，包含数据库连接信息、站点设置等。

hooks.py 示例内容：

# 自动安装的应用列表
auto_install = ["erpnext", "frappe"]

# 站点配置
site_config = {
    "host_name": "localhost",
    "port": 8000,
    "site_name": "example_site",
    "db_name": "example_db",
    "db_password": "password",
    "db_host": "localhost",
    "db_port": 3306,
}

json 配置文件内容通常是以JSON格式存储的配置信息，如下：

{
    "server_socket": "/tmp/frappe.sock",
    "socket_mode": 660,
    "data directories": "/path/to/data/directory"
}

确保正确配置这些文件，以便项目能够顺利启动和运行。