SuperLyric 项目启动与配置教程

1. 项目目录结构及介绍

SuperLyric 项目的目录结构如下所示：

SuperLyric/
├── .gitignore        # 忽略文件列表
├── Dockerfile        # Docker 构建文件
├── README.md         # 项目说明文件
├── config/           # 配置文件目录
│   └── settings.py   # 主配置文件
├── lyrics/           # 歌词文件目录
│   └── ...
├── migrations/       # 数据库迁移文件目录
│   └── ...
├── requirements.txt  # 项目依赖文件
├── run.py            # 项目启动文件
└── ...

• .gitignore：指定 Git 忽略跟踪的文件列表，以避免将不必要的文件提交到仓库。
• Dockerfile：用于构建项目的 Docker 容器镜像。
• README.md：项目的详细说明文件，包括项目描述、安装步骤、使用方法等。
• config/：存放项目配置文件的目录。
  • settings.py：项目的主配置文件，包含数据库连接、API 密钥等配置信息。
• lyrics/：存放歌词文件的目录。
• migrations/：存放数据库迁移文件的目录。
• requirements.txt：列出项目运行所需的依赖包。
• run.py：项目的启动文件。

2. 项目的启动文件介绍

项目的启动文件为 run.py。以下是 run.py 的基本内容：

from app import create_app

app = create_app()

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

该文件通过导入 app 模块中的 create_app 函数来创建一个应用实例，并在脚本被直接运行时，调用 run 方法启动应用。

3. 项目的配置文件介绍

项目的配置文件为 config/settings.py。以下是 settings.py 的基本内容：

# 数据库配置
DATABASE_URI = 'sqlite:///data.db'

# 应用配置
SECRET_KEY = 'your_secret_key'

在 settings.py 文件中，你可以定义各种配置项，如数据库连接字符串、应用密钥等。这些配置项会在项目运行时被读取，并用于初始化应用和其他组件。确保在部署时更新这些配置项，以符合你的实际环境需求。