Nostr Market 项目教程

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

Nostr Market 项目的目录结构如下：

nostrmarket/
├── README.md
├── LICENSE
├── requirements.txt
├── setup.py
├── nostrmarket/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── helpers.py
│   ├── templates/
│   │   ├── index.html
│   │   ├── merchant.html
│   ├── static/
│   │   ├── css/
│   │   ├── js/
│   ├── tests/
│   │   ├── __init__.py
│   │   ├── test_main.py
├── docs/
│   ├── index.md
│   ├── troubleshooting.md

目录结构介绍

• README.md: 项目的基本介绍和使用说明。
• LICENSE: 项目的开源许可证文件。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装脚本。
• nostrmarket/: 项目的主要代码目录。
  • __init__.py: 初始化文件。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • utils/: 工具函数和辅助模块。
  • templates/: HTML 模板文件。
  • static/: 静态资源文件，如 CSS 和 JavaScript。
  • tests/: 测试代码目录。
• docs/: 项目的文档目录。

2. 项目的启动文件介绍

项目的启动文件是 nostrmarket/main.py。该文件包含了项目的入口函数，负责初始化应用并启动服务器。

main.py 文件内容概述

from flask import Flask
from nostrmarket import config
from nostrmarket.utils import helpers

app = Flask(__name__)

# 加载配置
app.config.from_object(config)

# 初始化应用
helpers.init_app(app)

# 启动服务器
if __name__ == "__main__":
    app.run(debug=True)

启动文件功能

• 导入 Flask 框架并初始化应用。
• 加载项目的配置文件 config.py。
• 调用 helpers.init_app(app) 初始化应用的各个组件。
• 启动 Flask 服务器，默认在 debug 模式下运行。

3. 项目的配置文件介绍

项目的配置文件是 nostrmarket/config.py。该文件包含了项目的各种配置选项，如数据库连接、日志设置、API 密钥等。

config.py 文件内容概述

import os

# 基础配置
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
DEBUG = True
SECRET_KEY = 'your_secret_key'

# 数据库配置
SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(BASE_DIR, 'app.db')
SQLALCHEMY_TRACK_MODIFICATIONS = False

# 日志配置
LOG_LEVEL = 'DEBUG'
LOG_FILE = os.path.join(BASE_DIR, 'app.log')

# API 配置
API_KEY = 'your_api_key'

配置文件功能

• BASE_DIR: 项目根目录路径。
• DEBUG: 是否启用调试模式。
• SECRET_KEY: 应用的密钥，用于加密会话等。
• SQLALCHEMY_DATABASE_URI: 数据库连接字符串。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪数据库修改。
• LOG_LEVEL: 日志级别。
• LOG_FILE: 日志文件路径。
• API_KEY: API 密钥，用于外部接口调用。

通过以上配置文件，可以灵活调整项目的运行环境和行为。