Rin 开源项目使用教程

Rin 开源项目使用教程

Rin ⚡️Rin 是一个基于 Cloudflare Pages + Workers + D1 + R2 全家桶的博客，无需服务器无需备案，只需要一个解析到 Cloudflare 的域名即可部署。 项目地址: https://gitcode.com/gh_mirrors/rin/Rin

1. 项目目录结构及介绍

Rin 项目的目录结构如下：

Rin/
├── README.md
├── src/
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── helper.py
│   │   └── logger.py
│   └── models/
│       ├── user.py
│       └── post.py
├── tests/
│   ├── test_main.py
│   └── test_config.py
└── requirements.txt

目录结构介绍

• README.md: 项目说明文件，包含项目的简介、安装方法、使用说明等。
• src/: 项目的源代码目录。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • utils/: 包含项目中使用的工具函数和类。
    • helper.py: 辅助函数文件。
    • logger.py: 日志记录工具文件。
  • models/: 包含项目的模型定义文件。
    • user.py: 用户模型定义文件。
    • post.py: 帖子模型定义文件。
• tests/: 项目的测试代码目录。
  • test_main.py: 针对 main.py 的测试文件。
  • test_config.py: 针对 config.py 的测试文件。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目启动文件介绍

src/main.py

main.py 是项目的启动文件，负责初始化项目并启动应用程序。以下是 main.py 的主要功能：

from config import Config
from utils.logger import setup_logger
from models.user import User
from models.post import Post

def main():
    # 初始化配置
    config = Config()
    
    # 设置日志
    logger = setup_logger(config.log_level)
    
    # 初始化数据库连接
    db = init_db(config.db_url)
    
    # 创建用户和帖子
    user = User(db)
    post = Post(db)
    
    # 启动应用程序
    start_app(user, post)

if __name__ == "__main__":
    main()

主要功能介绍

• 初始化配置: 从 config.py 中加载配置信息。
• 设置日志: 根据配置文件中的日志级别设置日志记录。
• 初始化数据库连接: 根据配置文件中的数据库 URL 初始化数据库连接。
• 创建用户和帖子: 实例化 User 和 Post 模型。
• 启动应用程序: 调用 start_app 函数启动应用程序。

3. 项目配置文件介绍

src/config.py

config.py 是项目的配置文件，负责存储项目的各种配置信息。以下是 config.py 的主要内容：

class Config:
    def __init__(self):
        self.db_url = "sqlite:///database.db"
        self.log_level = "INFO"
        self.app_port = 8080
        self.debug_mode = True

配置项介绍

• db_url: 数据库连接 URL，默认为 SQLite 数据库。
• log_level: 日志记录级别，默认为 INFO。
• app_port: 应用程序监听的端口，默认为 8080。
• debug_mode: 是否启用调试模式，默认为 True。

通过修改 config.py 中的配置项，可以灵活地调整项目的运行环境。

Rin ⚡️Rin 是一个基于 Cloudflare Pages + Workers + D1 + R2 全家桶的博客，无需服务器无需备案，只需要一个解析到 Cloudflare 的域名即可部署。 项目地址: https://gitcode.com/gh_mirrors/rin/Rin