Fiction House 项目使用教程

1. 项目目录结构及介绍

fiction_house/
├── app/
│   ├── __init__.py
│   ├── models.py
│   ├── routes.py
│   └── views.py
├── config/
│   ├── __init__.py
│   ├── config.py
│   └── settings.py
├── migrations/
│   ├── __init__.py
│   ├── versions/
│   │   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_models.py
│   └── test_routes.py
├── .env
├── .gitignore
├── README.md
├── requirements.txt
└── run.py

目录结构说明

• app/: 包含应用程序的主要代码，包括模型、路由和视图。

  • __init__.py: 初始化应用程序包。
  • models.py: 定义数据库模型。
  • routes.py: 定义应用程序的路由。
  • views.py: 处理视图逻辑。

• config/: 包含项目的配置文件。

  • __init__.py: 初始化配置包。
  • config.py: 主配置文件，包含应用程序的配置选项。
  • settings.py: 包含环境特定的设置。

• migrations/: 包含数据库迁移文件。

  • __init__.py: 初始化迁移包。
  • versions/: 包含具体的迁移脚本。

• tests/: 包含测试代码。

  • __init__.py: 初始化测试包。
  • test_models.py: 测试数据库模型。
  • test_routes.py: 测试应用程序的路由。

• .env: 环境变量文件，包含敏感信息和配置。

• .gitignore: Git忽略文件，指定不需要跟踪的文件和目录。

• README.md: 项目说明文件。

• requirements.txt: 项目依赖文件，列出所有需要的Python包。

• run.py: 项目启动文件。

2. 项目启动文件介绍

run.py

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

from app import create_app

app = create_app()

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

启动步骤

1. 确保已经安装了所有依赖包，可以通过运行 pip install -r requirements.txt 来安装。
2. 运行 python run.py 启动应用程序。
3. 应用程序默认运行在 http://127.0.0.1:5000/，可以在浏览器中访问。

3. 项目的配置文件介绍

config/config.py

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

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'you-will-never-guess'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///site.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

配置项说明

• SECRET_KEY: 用于会话加密的密钥，可以从环境变量中获取，如果没有设置则使用默认值。
• SQLALCHEMY_DATABASE_URI: 数据库连接字符串，可以从环境变量中获取，如果没有设置则使用默认的SQLite数据库。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪对象的修改，设置为 False 以提高性能。

config/settings.py

settings.py 包含环境特定的设置，例如开发环境、测试环境和生产环境的配置。以下是文件的主要内容：

from .config import Config

class DevelopmentConfig(Config):
    DEBUG = True

class TestingConfig(Config):
    TESTING = True
    SQLALCHEMY_DATABASE_URI = 'sqlite:///:memory:'

class ProductionConfig(Config):
    DEBUG = False

配置项说明

• DevelopmentConfig: 开发环境的配置，启用调试模式。
• TestingConfig: 测试环境的配置，使用内存数据库。
• ProductionConfig: 生产环境的配置，关闭调试模式。

通过以上配置文件，可以根据不同的环境需求灵活配置应用程序。