# Django-Backend

**Repository Path**: initial_autumn/django-backend

## Basic Information

- **Project Name**: Django-Backend
- **Description**: 201所项目后端
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-10
- **Last Updated**: 2025-09-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 维保项目后端 Django 版

## 使用方法

### 在清华服务器上运行

```bash
cd /home/heyilong/prodfm/refine-backend
conda activate prodfm_backend
python manage.py runserver 0.0.0.0:60038
```

### 数据库

因为此项目使用了 PostgreSQL, 所以用户需要先安装 [PostgreSQL](https://www.postgresql.org/), 当然你也可以使用你喜欢的数据库，找到 `/config/settings.py`

```tree
config/
├── __init__.py
├── __pycache__
├── asgi.py
├── settings.py
├── urls.py
└── wsgi.py
```

修改其中的 `DATABASES`

```python
DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.postgresql",
        "HOST": "your_host",
        "USER": "your_username",
        "PASSWORD": "your_password",
        "NAME": "your_db_name",
        "OPTIONS": {
            "client_encoding": "UTF8",
        },
    }
}
```

然后新建数据库

```sql
CREATE DATABASE your_db_name;
```

### 安装依赖

依赖主要是通过 conda 管理的，当无法通过 conda 安装时，采用 pip 安装

1. 创建 conda 环境：

```bash
# 导航到项目根目录，然后
conda env create -f requirements/conda.yml
conda activate prodfm_backend
# 安装通过 pip 安装的依赖
pip install -r requirements/pip.txt
```

### 运行

```bash
# 项目采用了迁移，通过 django orm 管理数据库
python manage.py migrate
python manage.py runserver
```

### 插入数据

```bash
# auth 注册
# 需要临时注释掉项目配置里的 AUTH_PASSWORD_VALIDATORS 的 django.contrib.auth.password_validation.CommonPasswordValidator 
# 和 django.contrib.auth.password_validation.NumericPasswordValidator, 不然密码验证通不过
curl -X POST http://127.0.0.1:8000/auth/users/ -d "username=admin&password=12345678"

# 登录
curl -X POST http://127.0.0.1:8000/login -d "username=admin&password=12345678"

# 注册 Profile
# Windows PowerShell 采用反引号 ( ` ), 显式标明续行
curl -X POST http://127.0.0.1:8000/users/ `
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzM0Njg4NDQxLCJpYXQiOjE3MzQ2MDIwNDEsImp0aSI6ImFiNTNmMzE1YTg3ODQwYWZhMjExZjA0Y2MxOTBkNDhhIiwidXNlcl9pZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGVzIjpbXSwiam9iX251bWJlciI6IiJ9.w7PkeKnmasuE1s_o6c-RUVeqPcLcbpMq2Gk6b0oLB8o" `
-d '{"chinese_name": "管理员"}' `
-H "Content-Type: application/json"
```

## API 文档

项目运行起来以后，访问 <http://127.0.0.1:8000/api/schema/swagger-ui/> 可查看 Swagger UI

![Swagger](api_doc_img/swagger.png)

或者访问 <http://127.0.0.1:8000/api/schema/redoc/>, 查看 redoc

![redoc](api_doc_img/redoc.png)