mathhub/mathdb

MathDB Django

镜像概述和主要用途

MathDB Django是MathDB的后端应用，基于Django框架开发，支持本地开发环境搭建和Docker生产部署。该应用包含Django API服务和React前端组件，提供数据管理功能，默认使用SQLite数据库，可通过配置文件或环境变量进行灵活设置。

核心功能和特性

• Django后端服务：提供API接口，支持数据库迁移和数据管理
• React前端组件：独立的前端模块，需通过Yarn构建和启动
• 灵活配置：支持本地开发配置（mathdb/local_settings.py）和Docker环境变量配置
• 双部署模式：可在本地开发环境运行，也可通过Docker容器化部署到生产环境
• 自动构建：提供Docker Hub自动构建镜像（mathhub/mathdb）

使用场景和适用范围

• 本地开发：供开发人员在本地搭建开发环境，进行功能测试和调试
• 生产部署：通过Docker容器化部署到服务器，提供稳定的后端服务
• 教育/科研场景：适用于需要数学数据库后端支持的应用场景

使用方法和配置说明

本地开发环境搭建

前提条件

• Python 3.6或更高版本
• Node.js和Yarn（用于前端构建）

步骤

1. 克隆仓库并创建虚拟环境

bash
# 克隆代码仓库
git clone https://github.com/MathHubInfo/MathDBDjango.git
cd MathDBDjango

# 创建并激活虚拟环境
python3 -m venv venv
source venv/bin/activate  # Linux/macOS
# 或在Windows上使用: venv\Scripts\activate

2. 安装后端依赖并执行数据库迁移

bash
# 安装Python依赖
pip install -r requirements.txt

# 执行数据库迁移
python manage.py migrate

3. 构建前端组件

bash
# 进入前端目录
cd frontend

# 安装前端依赖
yarn

# 构建前端资源
yarn build

4. 启动服务

bash
# 启动Django API服务器（在项目根目录）
python manage.py runserver

# 启动前端开发服务器（在frontend目录）
cd frontend
yarn start

本地配置说明

• 主配置文件位于mathdb/settings.py
• 本地开发可创建mathdb/local_settings.py文件（已加入.gitignore），用于存储本地特定配置（如会话令牌、认证凭证等）
• 默认使用本地SQLite数据库（db.sqlite3）

Docker生产部署

前提条件

• Docker环境

步骤

1. 拉取镜像

bash
docker pull mathhub/mathdb

2. 运行容器

bash
docker run -d -p 8000:8000 --name mathdb mathhub/mathdb

Docker配置说明

• Docker环境使用配置文件mathdb/docker_settings.py
• 所有配置可通过环境变量设置，具体变量可参考Dockerfile
• 默认使用容器内SQLite数据库，可通过环境变量配置外部数据库连接

代码结构

遵循标准Django应用结构，入口点位于mathdb目录，包含Django项目配置和应用模块；前端代码位于frontend目录，使用React框架开发。

许可证

采用GPL3许可协议，详见LICENSE文件。