GenLM 控制项目启动与配置教程

1. 项目目录结构及介绍

GenLM 控制项目的目录结构如下：

genlm-control/
├── assets/             # 存放静态资源，如图片、样式表等
├── bin/                # 可执行脚本和启动文件
├── config/             # 配置文件目录
├── docs/               # 文档和教程目录
├── genlm/              # 项目核心代码目录
│   ├── __init__.py
│   ├── controller.py   # 控制器模块
│   ├── model.py        # 模型模块
│   └── utility.py      # 工具模块
├── requirements.txt    # 项目依赖文件
├── setup.py            # 项目安装和配置文件
└── tests/              # 测试代码目录

• assets/：包含项目所需的静态资源。
• bin/：存放项目的启动脚本和可执行文件。
• config/：存放项目的配置文件。
• docs/：存放项目的文档和教程。
• genlm/：项目核心代码，包含控制器、模型和工具模块。
• requirements.txt：记录项目所需的依赖库。
• setup.py：用于安装和配置项目。
• tests/：存放项目测试代码。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，通常为 start.sh（对于 Linux 和 macOS 系统）或 start.bat（对于 Windows 系统）。

对于 Linux 和 macOS 系统 (start.sh)

#!/bin/bash

# 进入项目根目录
cd "$(dirname "$0")"

# 激活虚拟环境（如果已配置）
# source .env/bin/activate

# 启动项目
python bin/app.py

对于 Windows 系统 (start.bat)

@echo off

REM 进入项目根目录
cd "%~dp0"

REM 激活虚拟环境（如果已配置）
REM .\.env\Scripts\activate

REM 启动项目
python bin\app.py

启动脚本会进入项目根目录，并运行 app.py 文件来启动项目。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，通常为一个名为 config.json 的文件。这个文件包含了项目运行所需的各种配置参数。

config.json 示例：

{
  "port": 5000,
  "host": "localhost",
  "debug": true,
  "database": {
    "url": "sqlite:///genlm.db",
    "echo": true
  }
}

• port: 项目运行的端口号。
• host: 项目运行的地址。
• debug: 是否开启调试模式。
• database: 数据库配置，包括数据库连接地址和是否打印日志。

确保正确配置这些参数，以适应不同的运行环境。