开源项目 Guya.moe 使用教程

开源项目 Guya.moe 使用教程

guyamoeKaguya Manga Reader Website项目地址:https://gitcode.com/gh_mirrors/gu/guyamoe

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

目录结构

guyamoe/
├── app/
│   ├── __init__.py
│   ├── routes.py
│   ├── models.py
│   ├── static/
│   └── templates/
├── config/
│   ├── __init__.py
│   ├── config.py
│   └── settings.py
├── migrations/
├── tests/
├── .env
├── .gitignore
├── README.md
├── requirements.txt
└── run.py

目录介绍

• app/: 包含应用程序的主要代码。
  • __init__.py: 初始化应用程序。
  • routes.py: 定义应用程序的路由。
  • models.py: 定义数据库模型。
  • static/: 存放静态文件，如CSS、JavaScript和图像。
  • templates/: 存放HTML模板文件。
• config/: 包含配置文件。
  • __init__.py: 初始化配置模块。
  • config.py: 主要的配置文件。
  • settings.py: 环境特定的设置。
• migrations/: 存放数据库迁移文件。
• tests/: 存放测试代码。
• .env: 环境变量文件。
• .gitignore: Git忽略文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• run.py: 应用程序的启动文件。

2. 项目的启动文件介绍

run.py

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

from app import create_app

app = create_app()

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

• from app import create_app: 从 app 模块导入 create_app 函数。
• app = create_app(): 创建应用程序实例。
• if __name__ == "__main__":: 确保只有在直接运行 run.py 时才启动应用程序。
• app.run(debug=True): 以调试模式启动应用程序。

3. 项目的配置文件介绍

config.py

config.py 是项目的主要配置文件，包含应用程序的各种配置选项。以下是 config.py 的基本内容：

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'your_secret_key'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///site.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

• SECRET_KEY: 用于会话加密的密钥。
• SQLALCHEMY_DATABASE_URI: 数据库的连接字符串。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪对象的修改。

settings.py

settings.py 包含环境特定的设置。以下是 settings.py 的基本内容：

import os

class DevelopmentConfig(Config):
    DEBUG = True

class ProductionConfig(Config):
    DEBUG = False
    TESTING = False

• DevelopmentConfig: 开发环境的配置。
• ProductionConfig: 生产环境的配置。

通过以上内容，您可以了解并配置 Guya.moe 项目的目录结构、启动文件和配置文件。希望这份教程对您有所帮助！

guyamoeKaguya Manga Reader Website项目地址:https://gitcode.com/gh_mirrors/gu/guyamoe