SiYuan 开源项目使用教程

SiYuan 开源项目使用教程

siyuanA privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.项目地址:https://gitcode.com/gh_mirrors/siy/siyuan

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

SiYuan 项目的目录结构如下：

siyuan/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── main.py
├── config/
│   └── settings.py
├── docs/
├── tests/
├── .gitignore
├── LICENSE
├── README.md
└── requirements.txt

目录结构介绍

• app/: 包含应用程序的主要代码。
  • controllers/: 存放控制器文件。
  • models/: 存放数据模型文件。
  • views/: 存放视图文件。
  • main.py: 应用程序的入口文件。
• config/: 包含配置文件。
  • settings.py: 主要的配置文件。
• docs/: 存放项目文档。
• tests/: 存放测试文件。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

项目的启动文件是 app/main.py。该文件负责启动整个应用程序。以下是 main.py 的主要内容：

from flask import Flask
from app.controllers import home

app = Flask(__name__)

app.register_blueprint(home.bp)

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

启动文件介绍

• from flask import Flask: 导入 Flask 类。
• from app.controllers import home: 导入控制器模块。
• app = Flask(__name__): 创建 Flask 应用实例。
• app.register_blueprint(home.bp): 注册蓝图。
• if __name__ == "__main__": app.run(debug=True): 启动应用，开启调试模式。

3. 项目的配置文件介绍

项目的配置文件位于 config/settings.py。该文件包含应用程序的各种配置选项。以下是 settings.py 的主要内容：

import os

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

class DevelopmentConfig(Config):
    DEBUG = True

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

class ProductionConfig(Config):
    DEBUG = False

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

配置文件介绍

• Config: 基础配置类，包含通用配置选项。
• DevelopmentConfig: 开发环境配置类，开启调试模式。
• TestingConfig: 测试环境配置类，使用内存数据库。
• ProductionConfig: 生产环境配置类，关闭调试模式。
• config: 配置字典，根据环境选择不同的配置类。

以上是 SiYuan 开源项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

siyuanA privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.项目地址:https://gitcode.com/gh_mirrors/siy/siyuan