South 开源项目使用教程

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

South 项目的目录结构如下：

south/
├── backend/
│   ├── app/
│   │   ├── __init__.py
│   │   ├── routes.py
│   │   ├── models.py
│   │   └── ...
│   ├── config/
│   │   ├── __init__.py
│   │   ├── settings.py
│   │   └── ...
│   ├── requirements.txt
│   ├── run.py
│   └── ...
├── frontend/
│   ├── public/
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── App.js
│   │   ├── index.js
│   │   └── ...
│   ├── package.json
│   ├── README.md
│   └── ...
├── README.md
└── ...

目录结构介绍

• backend/: 后端代码目录，使用 Python 的 Flask 框架。

  • app/: 包含应用的主要逻辑代码。
    • init.py: 初始化 Flask 应用。
    • routes.py: 定义应用的路由和视图函数。
    • models.py: 定义数据库模型。
  • config/: 配置文件目录。
    • settings.py: 包含应用的配置参数。
  • run.py: 启动后端应用的入口文件。

• frontend/: 前端代码目录，使用 React 框架。

  • public/: 存放静态资源文件。
  • src/: 包含前端的主要代码。
    • components/: 存放 React 组件。
    • pages/: 存放页面组件。
    • App.js: 应用的主组件。
    • index.js: 应用的入口文件。
  • package.json: 前端项目的依赖配置文件。

2. 项目的启动文件介绍

后端启动文件

• run.py: 这是后端应用的启动文件。通过运行此文件，可以启动 Flask 应用。

# run.py
from app import create_app

app = create_app()

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

前端启动文件

• index.js: 这是前端应用的入口文件。通过运行 npm start 命令，可以启动 React 应用。

// index.js
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, document.getElementById('root'));

3. 项目的配置文件介绍

后端配置文件

• settings.py: 这是后端应用的主要配置文件，包含数据库连接、密钥、调试模式等配置。

# settings.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 'postgresql://user:password@localhost/dbname'
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    DEBUG = True

前端配置文件

• package.json: 这是前端项目的依赖配置文件，包含项目的依赖包、脚本命令等信息。

{
  "name": "south-frontend",
  "version": "1.0.0",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3"
  }
}

通过以上配置和启动文件，您可以顺利启动并配置 South 项目，开始您的技术峰会管理之旅。