开源项目 `notes_system` 使用教程

开源项目 notes_system 使用教程

notes_systemСистема заметок с использованием Golang, Python и микросервисной архитектуры.项目地址:https://gitcode.com/gh_mirrors/no/notes_system

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

notes_system/
├── README.md
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── note.py
│   ├── routes/
│   │   ├── __init__.py
│   │   ├── note_routes.py
├── requirements.txt
├── tests/
│   ├── __init__.py
│   ├── test_note.py

• README.md: 项目说明文件。
• app/: 应用的主要代码目录。
  • __init__.py: 初始化文件。
  • main.py: 项目启动文件。
  • config.py: 配置文件。
  • models/: 数据模型目录。
    • note.py: 笔记模型文件。
  • routes/: 路由目录。
    • note_routes.py: 笔记相关路由文件。
• requirements.txt: 项目依赖文件。
• tests/: 测试代码目录。
  • test_note.py: 笔记相关测试文件。

2. 项目的启动文件介绍

app/main.py 是项目的启动文件。它包含了应用的初始化代码和启动命令。以下是 main.py 的主要内容：

from flask import Flask
from app.config import Config
from app.routes import note_routes

def create_app():
    app = Flask(__name__)
    app.config.from_object(Config)
    app.register_blueprint(note_routes)
    return app

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

• create_app(): 创建并配置 Flask 应用实例。
• app.run(debug=True): 启动应用，开启调试模式。

3. 项目的配置文件介绍

app/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:///notes.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

• SECRET_KEY: 应用密钥。
• SQLALCHEMY_DATABASE_URI: 数据库连接字符串。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪数据库修改。

notes_systemСистема заметок с использованием Golang, Python и микросервисной архитектуры.项目地址:https://gitcode.com/gh_mirrors/no/notes_system