Hertz System 文档

Appearance

安装指南（后端 Hertz Server Django） ​

本文介绍如何在本地搭建 Hertz Server Django 后端的开发环境，包括克隆代码、创建虚拟环境、安装依赖、配置环境变量和启动服务。

前置条件 ​

在开始之前，请确保已准备好以下环境：

  • 操作系统：Windows / Linux / macOS
  • Python：3.8 及以上版本（推荐 3.12.3）
  • 数据库：SQLite（开发环境）或 MySQL 5.7+（生产环境）
  • 缓存：Redis 5.0+
  • Git：用于拉取代码

关于更详细的数据库与 Redis 配置，可参考《环境配置》文档。

步骤一：获取源码 ​

在本机选择一个工作目录，执行：

bash
git clone https://github.com/your-repo/Hertz-server-django.git
cd Hertz_server_django

其中 <repository-url> 为实际的后端仓库地址（例如 HzGit 上的 hertz_django 仓库）。

步骤二：创建并激活虚拟环境 ​

推荐使用 Python 自带的 venv 创建隔离环境：

bash
# Windows
python -m venv venv
venv\Scripts\activate

# Linux / macOS
python3 -m venv venv
source venv/bin/activate

激活成功后，命令行前面通常会出现 (venv) 前缀。

步骤三：安装 Python 依赖 ​

在虚拟环境已激活的情况下执行：

bash
pip install --upgrade pip
pip install -r requirements.txt

依赖中已经包含 Django、Django REST Framework、Redis 驱动以及 YOLO/Ultralytics 等组件。

步骤四：配置环境变量（.env） ​

在项目根目录创建 .env 文件，并填入基础配置：

ini
# 基础配置
DEBUG=True
SECRET_KEY=your-secret-key
ALLOWED_HOSTS=localhost,127.0.0.1

# Redis / MySQL 配置
USE_REDIS_AS_DB=True
REDIS_URL=redis://127.0.0.1:6379/0

# 如需使用 MySQL，请取消注释并填写实际信息
# DB_NAME=Hertz_server
# DB_USER=root
# DB_PASSWORD=root
# DB_HOST=localhost
# DB_PORT=3306
  • 开发环境可以先使用 SQLite + Redis，生产环境建议使用 MySQL。
  • 更多环境变量说明，可参考《环境配置》文档。

步骤五：初始化数据库 ​

首次运行前需要迁移数据库结构：

bash
python manage.py makemigrations
python manage.py migrate

如需收集静态文件（生产环境）：

bash
python manage.py collectstatic

然后创建一个超级管理员账号：

bash
python manage.py createsuperuser

步骤六：启动开发服务器 ​

方式一：使用自动启动脚本（推荐） ​

项目提供了 start_server.py，可以自动完成迁移和初始化：

bash
python start_server.py

该脚本会：

  • 执行数据库迁移
  • 初始化基础数据与菜单/权限
  • 启动 ASGI 服务（如 Daphne）

方式二：使用 Django 自带开发服务器 ​

如果只是本地调试，也可以使用 runserver：

bash
python manage.py runserver 0.0.0.0:8000

步骤七：验证安装 ​

后端启动后，可以在浏览器中访问：

  • 后端根地址：http://localhost:8000
  • API 前缀：http://localhost:8000/api/

若能正常打开接口或登录页，即表示后端安装成功.