JournalBook 开源项目教程

JournalBook 开源项目教程

JournalBookJournalBook is a private, offline-first personal journal.项目地址:https://gitcode.com/gh_mirrors/jo/JournalBook

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

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

• app/: 包含应用程序的主要代码。
  • __init__.py: 初始化应用程序。
  • config.py: 配置文件。
  • models.py: 数据库模型。
  • routes.py: 路由定义。
  • static/: 静态文件（如CSS, JS）。
  • templates/: HTML模板文件。
• tests/: 包含测试代码。
  • __init__.py: 初始化测试模块。
  • test_basic.py: 基本测试用例。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖包列表。
• run.py: 项目启动文件。

2. 项目的启动文件介绍

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__":: 如果当前文件是主程序，则运行应用程序。
• app.run(debug=True): 以调试模式启动应用程序。

3. 项目的配置文件介绍

config.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:///' + os.path.join(basedir, 'data.sqlite')
    SQLALCHEMY_TRACK_MODIFICATIONS = False

class DevelopmentConfig(Config):
    DEBUG = True

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

class ProductionConfig(Config):
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL')

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

• Config: 基础配置类，包含通用配置选项。
  • SECRET_KEY: 密钥配置。
  • SQLALCHEMY_DATABASE_URI: 数据库URI配置。
  • SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪数据库修改。
• DevelopmentConfig: 开发环境配置。
  • DEBUG: 开启调试模式。
• TestingConfig: 测试环境配置。
  • TESTING: 开启测试模式。
  • SQLALCHEMY_DATABASE_URI: 测试数据库URI。
• ProductionConfig: 生产环境配置。
  • SQLALCHEMY_DATABASE_URI: 生产数据库URI。
• config: 配置字典，根据环境选择不同的配置类。

JournalBookJournalBook is a private, offline-first personal journal.项目地址:https://gitcode.com/gh_mirrors/jo/JournalBook