GummyCat 项目启动与配置教程

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

GummyCat 项目的目录结构如下：

GummyCat/
├── .gitignore           # Git 忽略文件配置
├── Dockerfile           # Docker 容器配置文件
├── README.md            # 项目说明文件
├── app/                 # 应用程序目录
│   ├── __init__.py
│   ├── main.py          # 主程序文件
│   ├── static/          # 静态文件目录
│   │   └── ...
│   ├── templates/       # 模板文件目录
│   │   └── ...
│   └── ...
├── config/              # 配置文件目录
│   ├── __init__.py
│   └── settings.py      # 配置文件
├── requirements.txt     # 项目依赖文件
└── test/                # 测试目录
    └── ...

目录解释：

• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• Dockerfile: 用于构建 Docker 容器的配置文件。
• README.md: 项目的基本介绍和说明。
• app: 包含项目的主要代码和应用逻辑。
  • main.py: 主程序文件，通常是程序的入口点。
  • static: 存放静态文件，如 CSS、JavaScript 和图片。
  • templates: 存放 HTML 模板文件。
• config: 包含项目配置文件。
  • settings.py: 定义项目的配置信息。
• requirements.txt: 列出项目运行所需的 Python 包。
• test: 包含项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件是位于 app 目录下的 main.py。该文件负责初始化应用程序并启动服务。以下是 main.py 的基本结构：

from app import create_app

app = create_app()

if __name__ == "__main__":
    app.run()

启动步骤：

1. 在项目根目录下，打开终端或命令提示符。
2. 运行以下命令启动应用程序：

python app/main.py

这将会启动应用程序，默认情况下，应用程序将在 http://127.0.0.1:5000/ 上运行。

3. 项目的配置文件介绍

项目的配置文件是位于 config 目录下的 settings.py。该文件定义了项目的各种配置，如数据库连接信息、应用程序密钥等。

以下是 settings.py 的基本结构：

# 配置信息
class Config:
    # 应用程序名称
    APP_NAME = "GummyCat"
    # 应用程序密钥
    SECRET_KEY = "your_secret_key"
    # 数据库配置
    SQLALCHEMY_DATABASE_URI = "sqlite:///your_database.db"
    # 其他配置...

配置步骤：

1. 在 settings.py 文件中，根据实际需要配置数据库连接、应用程序密钥等。
2. 确保在 app 目录下的 create_app 函数中加载这些配置：

from config import Config

def create_app():
    app = Flask(__name__)
    app.config.from_object(Config)
    # 其他初始化代码...
    return app

完成这些配置后，你可以按照启动步骤启动项目。