SE_Project

前端部署（GitHub Pages）

在此之前，建议先了解 GitHub Pages

需要一个特殊名字的 GitHub 仓库：你的GitHub账户名或组织名.github.io，记该仓库为 r。然后：

Settings -> Actions -> General，设置 Workflow permissions 为 Read and write permissions。
Settings -> Pages，设置 Build and deployment 中的 Source 为 GiuHub Actions。
克隆本仓库。
删除 .github/workflows/gh-pages.yml 第 10 行的 if: false。
修改 frontend/src/components/api/api.js 中的 SERVER_URL 为后端地址。
推送至 r。等待 GitHub Actions 运行完成。
等待 2 分钟。然后可以访问网址 你的GitHub账户名或组织名.github.io

如果想要本地开发……

务必将 NPM 镜像设置为 npmmirror。经我们测试，npm 官方源和 npmmirror 的 uglify-es 包是不一样的，且只有后者能正常 npm run build。

后端部署

推荐使用无 GIL、带 JIT 的 Python 3.13t（需自行编译）。

数据库与配置文件

安装 MySQL，并创建好一个数据库。在项目根目录创建 .env 文件，写入服务器配置：.env 的示例如下：

DATABASE_NAME=pku_backend
DATABASE_HOST=127.0.0.1
DATABASE_PORT=3306
DATABASE_PASSWORD=123456
DATABASE_USERNAME=root
PRIVATE_KEY_PATH=<path to private key>
LOGFILE_PATH=<path to log>

PRIVATE_KEY_PATH 是私钥文件的路径。私钥应当与前端中的公钥（可以在项目文件夹搜索 pubKey）配对。
LOGFILE_PATH 是日志文件的路径。

依赖项的安装

依赖项，不包含 `mysqlclient` 和 `python-alipay-sdk`：

pip install pycryptodomex django djangorestframework djangorestframework-simplejwt django-cors-headers Pillow python-decouple

如果你使用 Linux（仅在 Ubuntu 24.04 测试），建议使用虚拟环境：

sudo apt install python3-pip python3.12-venv # Ubuntu 24.04 官方源只有 Python 3.12。Python 3.13 请自行编译。
python3 -m venv .venv
source .venv/bin/activate # 假设使用 bash/zsh

安装 `mysqlclient`

Linux（仅在 Ubuntu 24.04 测试）

sudo apt install pkg-config python3-dev default-libmysqlclient-dev build-essential libssl-dev
export MYSQLCLIENT_CFLAGS=$(mysql_config --cflags)
export MYSQLCLIENT_LDFLAGS=$(mysql_config --libs)
pip install mysqlclient

安装 `python-alipay-sdk`

注：该依赖库暂不支持 Python 自由线程构建。如不需要接入支付宝，可不安装此库。

Linux（仅在 Ubuntu 24.04 测试）

首先安装 Rust 工具链。然后：

sudo apt install lib-ffi
pip install python-alipay-sdk

启动服务器

python manage.py runserver 0.0.0.0:8000

BackendPerfTest, 后端性能测试

安装 Erlang/OTP 27；
安装 Elixir 1.18；对于 Windows，安装以上两者是简单的。对于 Linux（仅在 Ubuntu 24.04 测试），请依 Install Elixir 操作。
（可选）为 Hex 包管理器配置中国大陆镜像源（又拍云）
```
mix hex.config mirror_url https://hexpm.upyun.com
```
克隆本仓库，找到 backend_perf 文件夹；
运行 mix deps.get 获取依赖库；

在 config 文件夹下新建 config.exs

import Config

config :backend_perf,
  host: # 主机地址，如 "127.0.0.1:8000"

在启动后端的情况下，运行 mix test 测试。

数据传输标准

返回的详细信息，如果出错则统一为 detail，正常则统一为 message。

User

user-list

http://backend-ip:8000/users/

GET 获取当前所有用户的信息列表

status_code=200

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "email": "123456@qq.com",
      "id": 1,
      "is_active": true,
      "is_staff": false,
      "password": "4d28edb601106a84742a3c1a394db573d5c8bf2bdc86c36a3652bdad67c7db11",
      "uid": 1000001,
      "username": "123456"
    },
    {
      "email": "test@qq.con",
      "id": 2,
      "is_active": true,
      "is_staff": false,
      "password": "1015c01afd731ee9494902a36d98aca8615f37a695a1ce7e99627c37ba015c85",
      "uid": 1000002,
      "username": "test"
    }
  ]
}

user-detail

http://backend-ip:8000/users/detail/?username=xxx

GET 获取 username 为 xxx 的用户详细信息

avatar: 头像 url

status_code=200

{
  "avatar": "/media/avatar/user_1000002/image-2.png",
  "email": "123456@qq.com",
  "introduction": "Nothing here.hhh",
  "message": "Find the user successfully. 成功找到该用户。",
  "nickname": "user1000002",
  "point": 648833,
  "username": "123456"
}

若该用户不存在，则返回

status_code=404

{
  "detail": "User doesn't exist. 该用户不存在。"
}

user-register

http://backend-ip:8000/users/register/

POST 向后端提交注册信息 TODO:暂定只需传递以下字段

{
  "email": "Alice@gmail.com",
  "username": "Alice",
  "password_encrypted": "wevn852"
}

若数据库中已有 email 或 username，返回错误

status_code=400

{
  "detail": "Email already exists.邮箱已存在。"
}

或

{
  "detail": "Username already exists.用户名已存在。"
}

成功注册则返回

status_code=200

{
  "email": "11111@qq.com",
  "id": 12,
  "is_active": true,
  "is_staff": false,
  "uid": 1000012,
  "username": "testttt"
}

user-login

http://backend-ip:8000/users/login/

POST 向后端提交登录信息 TODO:暂定只需传递以下字段

{
  "email": "Alice@gmail.com",
  "password_encrypted": "wevn852"
}

登录成功后端返回

status_code=200

{
  "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI5NzQ3NTc2LCJpYXQiOjE3Mjk3NDcyNzYsImp0aSI6ImJhMWRhOTMyMWJmYjQyOWVhZTJiNDBmOGFhOTdhZDY2IiwidXNlcl9pZCI6MX0.YKAtBt7fAzr8Q8cenyrJfrCAuMWb41co22okeZ1zuoo",
  "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcyOTgzMzY3NiwiaWF0IjoxNzI5NzQ3Mjc2LCJqdGkiOiI3YjdmYzc4YzU1MTc0ODUzOGY1ZGFmMDA2MTk0Y2ExYyIsInVzZXJfaWQiOjF9.TWVHrAkGZlQFEhEGgENiA_V75Fh_EVRcr1kdAiusF_0",
  "user": {
    "email": "Alice@gmail.com",
    "is_active": true,
    "username": "Alice"
  }
}

登录失败后端返回

status_code=400

{
  "detail": "Invalid email.邮箱不存在。"
}

或

{
  "detail": "Invalid password.密码错误。"
}

token-refresh

http://backend-ip:8000/users/token/refresh/

POST 向后端提交之前获取的 refresh

{
  "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcyOTgzMzY3NiwiaWF0IjoxNzI5NzQ3Mjc2LCJqdGkiOiI3YjdmYzc4YzU1MTc0ODUzOGY1ZGFmMDA2MTk0Y2ExYyIsInVzZXJfaWQiOjF9.TWVHrAkGZlQFEhEGgENiA_V75Fh_EVRcr1kdAiusF_0"
}

后端返回更新后的 access

status_code=200

{
  "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzM0MTg4Njg2LCJpYXQiOjE3MzQxODY4MjYsImp0aSI6IjQ5ZTY2MmI2MTI1ODQxMDliYzU3ZGE3OWU3NjE3ZDZkIiwidXNlcl9pZCI6MX0.ftsZ8dpZ6028bRY_FqtBOt1c8BF-B0WR4sBvMXOp6sI",
  "message": "Access token has been refreshed. access令牌已更新。"
}

若 refresh 错误，后端返回

status_code=401

{
  "detail": "Token is invalid or expired.令牌无效或已过期。"
}

user-profile

http://backend-ip:8000/users/profile/

GET 前端获取当前登录用户的主页信息 TODO:

需要在 header 中包含Authorization:"Bearer <之前获取的 access>"（没有尖括号）

user-avatar-upload

http://backend-up:8000/users/profile/update/avatar/

POST 数据体中包含头像文件，名称为 avatar

status_code=200

{
  "avatar": "/media/avatar/user_1000002/008eulSmgy1hkazlfbtz6j32401eoe84-%E5%A4%B4%E5%83%8F.jpg",
  "user": "123456"
}

缺少头像文件或文件不是图片类型，则返回 400，分别为

{
  "detail": "The file is not an image. 该文件不是图片。"
}

和

{
  "detail": "No avatar file uploaded. 未上传头像文件。"
}

experiment

experiment-list

http://backend-ip:8000/experiments/

GET 前端获取所有的实验信息

{
    "count": 7,
    "next": null,
    "previous": null,
    "results": [
        {
            "creator": 1,
            "description": "This is a test experiment.",
            "id": 1,
            "money_left": "0.00",
            "money_paid": "0.00",
            "money_per_person": "10.00",
            "person_already": 0,
            "person_wanted": 20,
            "status": "open",
            "time_created": "2024-11-13T15:52:50.431072+08:00",
            "time_modified": "2024-11-13T15:52:50.431078+08:00",
            "title": "test_exp"
        },
        {
            "creator": 1,
            "description": "This is a test experiment.",
            "id": 2,
            "money_left": "0.00",
            "money_paid": "0.00",
            "money_per_person": "10.00",
            "person_already": 0,
            "person_wanted": 20,
            "status": "open",
            "time_created": "2024-11-13T16:20:06.554001+08:00",
            "time_modified": "2024-11-13T16:20:06.554006+08:00",
            "title": "test_exp"
        },
        ...
    ]
}

experiment-detail

http://backend-ip:8000/experiments/<int:pk>/

GET 获取 id 为 pk 的实验详细信息

headers 中包含 Authorization，用于判断 relationship

relationship 取值
- 未登录：unauthorized
- 创建者：creator
- 已申请者：根据其参与程度细分
  - to-qualify-user
  - to-check-result
  - finish
- 非创建也未申请：passer-by
creator
- 现在返回的是用户的 username
可以显示 tags 的详细信息

status_code=200

{
  "id": 2,
  "title": "test3",
  "description": "hhh",
  "status": "open",
  "creator": "abc",
  "person_wanted": 4,
  "person_already": 2,
  "money_per_person": 1,
  "money_paid": 0,
  "money_left": 0,
  "time_created": "2024-12-16T15:47:25.074657+08:00",
  "time_modified": "2024-12-17T11:02:35.277523+08:00",
  "activity_location": "家四",
  "activity_time": "2024-12-16",
  "image": "/media/experiment/default.jpg",
  "tags": [
    {
      "id": 1,
      "name": "tag1"
    },
    {
      "id": 2,
      "name": "tag2"
    }
  ],
  "message": "Find the experiment successfully. 成功找到该实验。",
  "relationship": "to-qualify-user"
}

experiment-create

http://backend-ip:8000/experiments/create/

POST 前端向后端发送要创建的实验信息，进行此功能必须先登录

前端发送：

{
  "title": "xxx",
  "description": "xxx",
  "person_wanted": 20,
  "money_per_person": 10,
  "tags": 13,
  "activity_time": "2024-01-01",
  "activity_location": "北京大学"
}

这里，15 = 0b1101，意为该实验包含 id 为 1、3、4 的 tag。

后端返回创建后的详细信息：

status_code=200

{
  "creator": 1,
  "description": "This is another test experiment.",
  "id": 8,
  "money_left": "0.00",
  "money_paid": "0.00",
  "money_per_person": "10.00",
  "person_already": 0,
  "person_wanted": 20,
  "status": "open",
  "time_created": "2024-11-13T22:22:54.415083+08:00",
  "time_modified": "2024-11-13T22:22:54.415104+08:00",
  "title": "another_test_exp",
  "activity_time": "2024-01-01",
  "activity_location": "北京大学"
}

experiment-search

http://backend-ip:8000/experiments/search/?keyword=bbb&orderby=ccc&sort=ddd

GET 查找 keyword 中包含 bbb 且按 ccc 字段降序或升序排列的实验列表

三个关键字可部分使用，keyword 默认为空（即包含全部实验），orderby 默认按 id，sort 可选 asc 或 desc，默认为 asc。

后端返回满足搜索条件的实验列表

status_code=200

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "activity_location": "家四",
            "activity_time": "2024-12-16",
            "creator": 1,
            "description": "hhh",
            "id": 1,
            "money_left": "0.00",
            "money_paid": "0.00",
            "money_per_person": "0.00",
            "person_already": 0,
            "person_wanted": 4,
            "status": "open",
            "time_created": "2024-12-16T15:46:00.454790+08:00",
            "time_modified": "2024-12-16T15:46:00.454868+08:00",
            "title": "test1"
        },
        ...
    ]
}

experiment-create-search

http://127.0.0.1:8000/experiments/create/search/?keyword=aaa&orderby=bbb&sort=ccc

engagement

experiment-engage

http://backend-ip:8000/relations/engage/

POST

experiment-engage-search

http://backend-ip:8000/relations/engage/search/?keyword=aaa&orderby=bbb&sort=ccc

qualification

qualify-volunteer

http://backend-ip:8000/relations/qualify/volunteers/

volunteer-list

http://backend-ip:8000/relations/volunteers/list/?experiment=xxx

GET 设置 xxx 为 experiment id，获取所有已申请该实验的志愿者详细信息。

后端返回志愿者列表

status_code=200

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "user": {
                "email": "abcd@abcd.com",
                "username": "abc",
                "userprofile": {
                    "id": 1,
                    "nickname": "user1000001",
                    "avatar": "/media/avatar/user_0/default_avatar.png",
                    "point": 200,
                    "introduction": "Nothing here.",
                    "user": 1
                }
            },
            "status": "finish"
        },
    ...
    ]
}

other

所有需要登录进行的操作，若未登录或 token 过期，均返回 401_UNAUTHORIZED 错误，其中

若未登录

status_code=401

{
  "detail": "Authentication required. 该功能需要先登录。"
}

若令牌无效或过期

status_code=401

{
  "code": "token_not_valid",
  "detail": "此令牌对任何类型的令牌无效",
  "messages": [
    {
      "message": "令牌无效或已过期",
      "token_class": "AccessToken",
      "token_type": "access"
    }
  ]
}

refresh token 过期:

{
  "code": "token_not_valid",
  "detail": "令牌无效或已过期"
}

所有 tag：

API：<host>:<port>/relations/tags/
方法：GET
返回

[
  {
    "name": "tag1"
  },
  {
    "name": "tag2"
  }
]

用户信息的更新：

API：<host>:<port>/users/profile/edit/
方法：POST

请求体：

{
  "email": "alice@gmail.com",
  "username": "alice",
  "old_password_encrypted": "",
  "new_password_encrypted": ""
}

以上字段不必同时存在。例如，如果只更新密码：

{
  "old_password_encrypted": "",
  "new_password_encrypted": ""
}

只更新 email：

{ "email": "alice@gmail.com" }

实验信息更新

API：<host>:<port>/experiments/edit/
方法：POST

请求体：

{
  "id": 1,
  "title": "Exp 1",
  "description": "desc 1",
  "person_wanted": 1,
  "money_per_person": 1,
  "activity_time": "",
  "activity_location": ""
}

除 id 外，以上字段不必同时存在。如果只更新标题：

{
  "id": 1,
  "title": "Exp 1"
}

Name		Name	Last commit message	Last commit date
Latest commit History 257 Commits
.github/workflows		.github/workflows
UI设计		UI设计
backend		backend
backend_perf		backend_perf
frontend		frontend
.gitignore		.gitignore
OOD-人机交互.png		OOD-人机交互.png
OOD-控制驱动.png		OOD-控制驱动.png
OOD-数据管理.png		OOD-数据管理.png
README.md		README.md
backlog-phase3.jpg		backlog-phase3.jpg
backlog.jpg		backlog.jpg
kanban.jpg		kanban.jpg
kanban.png		kanban.png
包图.png		包图.png
状态图.png		状态图.png
甘特图 phase_4.png		甘特图 phase_4.png
甘特图-phase2.png		甘特图-phase2.png
甘特图-phase3.png		甘特图-phase3.png
甘特图.png		甘特图.png
用况图.jpg		用况图.jpg
用况图2.0.png		用况图2.0.png
类图.png		类图.png
软件需求说明书.docx		软件需求说明书.docx
软件项目开发计划.docx		软件项目开发计划.docx
软工6组pre1.pptx		软工6组pre1.pptx
顺序图.png		顺序图.png

chyyy510/SE_Project

Folders and files

Latest commit

History

Repository files navigation

SE_Project

前端部署（GitHub Pages）

如果想要本地开发……

后端部署

数据库与配置文件

依赖项的安装

依赖项，不包含 mysqlclient 和 python-alipay-sdk：

安装 mysqlclient

Linux（仅在 Ubuntu 24.04 测试）

安装 python-alipay-sdk

Linux（仅在 Ubuntu 24.04 测试）

启动服务器

BackendPerfTest, 后端性能测试

数据传输标准

User

user-list

user-detail

user-register

user-login

token-refresh

user-profile

user-avatar-upload

experiment

experiment-list

experiment-detail

experiment-create

experiment-search

experiment-create-search

engagement

experiment-engage

experiment-engage-search

qualification

qualify-volunteer

volunteer-list

other

所有 tag：

用户信息的更新：

实验信息更新

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Contributors 4

Languages

依赖项，不包含 `mysqlclient` 和 `python-alipay-sdk`：

安装 `mysqlclient`

安装 `python-alipay-sdk`

Packages