SJTU-Annual-Eat 项目启动与配置指南

1. 项目目录结构及介绍

SJTU-Annual-Eat 项目的目录结构如下所示：

SJTU-Annual-Eat/
├── .gitignore           # 忽略文件列表
├── README.md            # 项目说明文件
├── config/              # 配置文件目录
│   └── config.json      # 配置文件
├── data/                # 数据存储目录
├── docs/                # 文档目录
├── frontend/            # 前端代码目录
│   ├── index.html       # 入口 HTML 文件
│   ├── ...
│   └── ...
├── backend/             # 后端代码目录
│   ├── app.py           # 主应用程序文件
│   ├── ...
│   └── ...
└── ...

• .gitignore: 指定 Git 应该忽略的文件和目录。
• README.md: 项目说明文件，包含项目的相关信息和说明。
• config/: 存放配置文件的目录。
  • config.json: 项目的主要配置文件。
• data/: 存放项目数据文件的目录。
• docs/: 存放项目文档的目录。
• frontend/: 前端代码目录，包含了 HTML、CSS 和 JavaScript 文件。
  • index.html: 前端入口页面。
• backend/: 后端代码目录，包含了服务器端代码和逻辑。

2. 项目的启动文件介绍

SJTU-Annual-Eat 项目的启动主要是通过后端目录 backend 下的 app.py 文件来进行的。以下是 app.py 文件的主要内容：

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello, World!'

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

该文件使用 Flask 框架创建了一个简单的 Web 应用程序。hello_world 函数定义了一个路由，当访问主页时，将返回 "Hello, World!"。

启动项目时，需要在命令行中进入 backend 目录，并运行以下命令：

python app.py

这将启动 Flask 应用程序，默认情况下，它将在 http://127.0.0.1:5000/ 地址上运行。

3. 项目的配置文件介绍

项目的配置文件位于 config 目录下的 config.json 文件。这是一个 JSON 格式的文件，用于存储项目的配置信息。以下是一个示例：

{
    "database": {
        "host": "localhost",
        "user": "root",
        "password": "password",
        "database": "sjtu_annual_eat"
    },
    "frontend": {
        "port": 8080
    }
}

在这个配置文件中，定义了数据库的连接信息（包括主机、用户、密码和数据库名），以及前端服务的端口。

在实际应用中，可以通过读取 config.json 文件来获取这些配置信息，并在应用程序中使用这些配置。例如：

import json

with open('config/config.json', 'r') as f:
    config = json.load(f)

db_config = config['database']
front_config = config['frontend']

以上代码将配置文件中的信息加载到一个字典中，然后可以按照需要使用这些配置信息。