ScribbleHub 开源项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00630/article/details/141621845

ScribbleHub 开源项目教程

ScribbleHub基于SpringBoot3开发的轻量级技术博客小程序,支持文章发布(支持上传音频内容或视频内容) 专题管理搜索以及渲染以及文章评论功能无需第三方OSS存储,使用的是服务器存储空间详细请看yml中的file配置项目地址:https://gitcode.com/gh_mirrors/sc/ScribbleHub

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

ScribbleHub 项目的目录结构如下：

ScribbleHub/
├── README.md
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── user.py
│   │   └── story.py
│   ├── routes/
│   │   ├── __init__.py
│   │   ├── user_routes.py
│   │   └── story_routes.py
│   └── static/
│       ├── css/
│       ├── js/
│       └── images/
└── tests/
    ├── __init__.py
    ├── test_user.py
    └── test_story.py

目录结构介绍

README.md: 项目说明文件。
app/: 应用的主要代码目录。
- __init__.py: 初始化文件。
- main.py: 应用的启动文件。
- config.py: 配置文件。
- models/: 数据模型目录。
  - user.py: 用户模型。
  - story.py: 故事模型。
- routes/: 路由目录。
  - user_routes.py: 用户相关路由。
  - story_routes.py: 故事相关路由。
- static/: 静态文件目录。
  - css/: CSS 文件。
  - js/: JavaScript 文件。
  - images/: 图片文件。
tests/: 测试代码目录。
- test_user.py: 用户相关测试。
- test_story.py: 故事相关测试。

2. 项目的启动文件介绍

项目的启动文件是 app/main.py。该文件负责初始化应用并启动服务器。以下是 main.py 的主要内容：

from flask import Flask
from app import config

app = Flask(__name__)
app.config.from_object(config)

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

启动文件介绍

导入 Flask 和配置模块。
创建 Flask 应用实例。
从配置模块加载配置。
启动应用服务器，开启调试模式。

3. 项目的配置文件介绍

项目的配置文件是 app/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:///your_database.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

class DevelopmentConfig(Config):
    DEBUG = True

class ProductionConfig(Config):
    DEBUG = False

config = {
    'development': DevelopmentConfig,
    'production': ProductionConfig,
    'default': DevelopmentConfig
}