Wins-11 项目启动与配置教程

1. 项目目录结构及介绍

Wins-11 项目采用以下目录结构：

wins-11/
├── README.md
├── config/
│   ├── app.json
│   └── database.json
├── src/
│   ├── main.py
│   ├── utils/
│   │   └── helper.py
│   └── models/
│       └── example_model.py
├── tests/
│   └── test_main.py
└── requirements.txt

以下是各个目录和文件的简要说明：

• README.md：项目说明文件，包含项目简介、安装指南、使用方法等信息。
• config：配置文件目录，包含项目所需的各种配置信息。
• app.json：应用程序配置文件，定义了项目的通用配置。
• database.json：数据库配置文件，定义了数据库连接信息。
• src：源代码目录，包含项目的主要代码。
• main.py：项目主程序文件，负责项目启动和运行。
• utils：工具类目录，包含项目中常用的工具函数。
• helper.py：辅助工具类文件。
• models：模型目录，包含项目中的数据模型。
• example_model.py：示例模型文件。
• tests：测试目录，包含项目测试代码。
• test_main.py：主程序测试文件。
• requirements.txt：项目依赖文件，列出了项目所需的第三方库。

2. 项目启动文件介绍

项目的启动文件为 src/main.py。以下是 main.py 文件的主要内容：

import json
from utils.helper import Helper

def main():
    # 加载配置文件
    with open('config/app.json', 'r') as f:
        app_config = json.load(f)
    
    # 初始化助手
    helper = Helper(app_config)
    
    # 执行助手任务
    helper.run()

if __name__ == "__main__":
    main()

main.py 文件负责加载配置文件、初始化助手类，并调用助手类的 run 方法来启动项目。

3. 项目配置文件介绍

项目包含两个配置文件：app.json 和 database.json。

app.json

app.json 文件定义了应用程序的通用配置，如下所示：

{
    "name": "Wins-11",
    "version": "1.0.0",
    "description": "A simple Wins-11 project."
}

database.json

database.json 文件定义了数据库连接信息，如下所示：

{
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "password",
    "database": "wins11"
}

在项目启动时，main.py 会加载这两个配置文件，并根据配置文件中的信息进行相应的初始化操作。