georef-ar-api 项目启动与配置教程

1. 项目目录结构及介绍

georef-ar-api 项目的主要目录结构如下：

georef-ar-api/
├── .gitignore               # Git 忽略文件列表
├── Dockerfile               # Docker 容器构建文件
├── README.md                # 项目说明文件
├── Spinner                  # 项目启动加载动画相关文件
│   └── ...
├── config                   # 配置文件目录
│   ├── default.json         # 默认配置文件
│   ├── development.json     # 开发环境配置文件
│   └── production.json      # 生产环境配置文件
├── db                       # 数据库相关文件
│   └── ...
├── georef-ar-api           # 项目核心代码目录
│   ├── __init__.py          # 初始化文件
│   ├── app.py               # 应用启动文件
│   ├── ...
│   └── ...
├── logs                     # 日志文件目录
│   └── ...
├── requirements.txt         # 项目依赖文件
└── tests                    # 测试代码目录
    └── ...

• .gitignore：指定 Git 进行版本控制时需要忽略的文件和目录。
• Dockerfile：用于构建项目 Docker 容器的配置文件。
• README.md：项目说明文件，通常包含项目介绍、安装指南、使用说明等。
• Spinner：项目启动加载动画的相关文件。
• config：配置文件目录，包含默认配置以及不同环境下的配置文件。
• db：与数据库相关的文件，如数据库迁移脚本等。
• georef-ar-api：项目核心代码目录，包含初始化文件、应用启动文件等。
• logs：日志文件目录，用于存储项目运行过程中的日志信息。
• requirements.txt：项目依赖文件，列出项目运行所需的所有 Python 包。
• tests：测试代码目录，用于存储项目的单元测试和集成测试代码。

2. 项目的启动文件介绍

项目的启动文件位于 georef-ar-api/app.py，以下是启动文件的主要内容：

from flask import Flask
from flask.json import JSONEncoder
from .config import Config

app = Flask(__name__)
app.json_encoder = JSONEncoder
app.config.from_object(Config)

# 路由和视图函数配置

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

该文件使用 Flask 框架创建了一个 Web 应用，并从配置文件中加载了配置信息。app.run() 调用启动了 Flask 应用。

3. 项目的配置文件介绍

项目的配置文件位于 config 目录下，通常包括以下三个文件：

• default.json：默认配置文件，包含所有环境的通用配置。
• development.json：开发环境配置文件，包含特定于开发环境的配置。
• production.json：生产环境配置文件，包含特定于生产环境的配置。

配置文件示例（default.json）：

{
    "APP_NAME": "georef-ar-api",
    "APP_ENV": "development",
    "DATABASE_URI": "sqlite:///georef-ar-api.db",
    "SECRET_KEY": "your-secret-key"
}

配置文件中定义了应用的基本信息，如应用名称、环境、数据库连接字符串等。在不同的环境中，可以通过设置环境变量来指定使用哪个配置文件。例如，设置 APP_ENV 环境变量为 production，则 Flask 应用会加载 production.json 文件作为配置。