Petal 项目启动与配置教程

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

Petal 项目的目录结构如下：

Petal/
├── assets/         # 存放静态资源，如图片、样式表等
├── config/         # 配置文件目录
├── docs/           # 项目文档
├── lib/            # 存放项目依赖库
├── scripts/        # 脚本文件，如项目启动脚本等
├── src/            # 源代码目录
│   ├── components/ # 通用组件
│   ├── models/     # 数据模型
│   ├── pages/      # 页面文件
│   ├── services/   # 服务接口
│   └── utils/      # 工具类
├── test/           # 测试文件
└── README.md       # 项目说明文件

• assets/：包含项目中使用的静态资源，如图标、图片、CSS文件等。
• config/：项目配置文件存放目录。
• docs/：项目相关文档。
• lib/：存放项目依赖的库文件。
• scripts/：包含项目运行所需的脚本文件。
• src/：源代码目录，包含项目的核心代码。
  • components/：通用组件。
  • models/：数据模型。
  • pages/：各个页面的代码。
  • services/：服务接口。
  • utils/：工具类。
• test/：存放测试相关的文件。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 scripts/ 目录下，通常为 start.sh（对于Linux系统）或 start.bat（对于Windows系统）。以下是启动文件的简单介绍：

• start.sh：Linux系统的启动脚本，通常会使用以下命令运行：

./start.sh

该脚本会设置环境变量、加载配置文件，并启动项目。

• start.bat：Windows系统的启动脚本，双击运行即可。脚本内容通常包含以下命令：

@echo off
setlocal
call setenv.bat
python main.py
endlocal

该脚本会设置环境变量，然后运行主程序。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，通常包括以下文件：

• config.json：项目的通用配置文件，可能包含数据库连接信息、API密钥、第三方服务的配置等。

{
  "database": {
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "password",
    "dbname": "petal_db"
  },
  "api_keys": {
    "service1": "API_KEY_1",
    "service2": "API_KEY_2"
  },
  "third_party": {
    "service3": {
      "url": "https://service3.example.com",
      "timeout": 5000
    }
  }
}

• env.py：环境变量配置文件，用于设置不同的环境变量，如开发环境、测试环境和生产环境。

import os

# Development environment
os.environ['ENV'] = 'development'
os.environ['DATABASE_URL'] = 'mysql://user:password@localhost/petal_db'

# Test environment
# os.environ['ENV'] = 'test'
# os.environ['DATABASE_URL'] = 'mysql://user:password@localhost/petal_test_db'

# Production environment
# os.environ['ENV'] = 'production'
# os.environ['DATABASE_URL'] = 'mysql://user:password@localhost/petal_prod_db'

通过这些配置文件，可以方便地管理项目在不同环境下的配置需求。