开源项目 Hummingbird 使用教程

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

hummingbird/
├── README.md
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── routes.py
├── config/
│   ├── development.py
│   ├── production.py
│   └── settings.py
├── requirements.txt
└── run.py

• README.md: 项目介绍文件。
• app/: 应用目录，包含控制器、模型、视图和路由。
  • controllers/: 控制器文件夹，处理业务逻辑。
  • models/: 模型文件夹，定义数据模型。
  • views/: 视图文件夹，处理前端显示。
  • routes.py: 路由配置文件。
• config/: 配置文件目录，包含开发和生产环境的配置。
  • development.py: 开发环境配置。
  • production.py: 生产环境配置。
  • settings.py: 通用配置文件。
• requirements.txt: 项目依赖文件。
• run.py: 项目启动文件。

2. 项目的启动文件介绍

run.py 是项目的启动文件，负责启动应用服务器。以下是 run.py 的基本内容：

from app import create_app

app = create_app()

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

• create_app(): 创建应用实例的函数。
• app.run(debug=True): 启动应用服务器，并开启调试模式。

3. 项目的配置文件介绍

config/ 目录下包含项目的配置文件，主要分为开发环境和生产环境。

development.py

开发环境的配置文件，包含调试模式、数据库连接等配置：

DEBUG = True
SQLALCHEMY_DATABASE_URI = 'sqlite:///dev.db'

production.py

生产环境的配置文件，包含生产环境的数据库连接等配置：

DEBUG = False
SQLALCHEMY_DATABASE_URI = 'mysql://user:password@localhost/prod'

settings.py

通用配置文件，包含一些通用的配置项：

SECRET_KEY = 'your_secret_key'
SQLALCHEMY_TRACK_MODIFICATIONS = False

通过这些配置文件，可以灵活地切换和管理不同环境下的项目配置。