# agileSD

**Repository Path**: caroline73/agile-sd

## Basic Information

- **Project Name**: agileSD
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-27
- **Last Updated**: 2024-05-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 一、通过Docker Compose 部署SpringBoot

##  1.下载源码

1.1 下载git

```bash
yum -y group install "Development Tools" 
```

1.2 下载源码

```bash
git clone https://gitee.com/caroline73/agile-sd.git 
```

1.3 跳转到目标目录

```bash
cd agile-sd 
```

## 2. 构建Jar包文件

2.1 创建一个存放`Maven仓库`的卷,缓存Maven的依赖，可加快构建速度。

```bash
docker volume create --name ssadmin-maven-repo
```

2.2 使用 Maven Docker 镜像来编译和打包 Spring Boot 应用。 已在pom.xml文件中增加了镜像地址。

2.3 在 Docker 中设置一个 Maven 环境，用于构建项目。

```bash
docker run -it --rm --name ssadmin-maven \
    -v ssadmin-maven-repo:/root/.m2 \
    -v "$PWD/src/demo20230927":/usr/src/mymaven \
    -w /usr/src/mymaven \
    maven:3.8.4-jdk-8 mvn clean install package -e -Dmaven.test.skip=true
```



# 二、web操作文档

## 1.用户登录

* 打开前端web页面会默认重定向到登录界面 `/login`
* 输入账户和密码，登录成功后将保存用户token，以记录用户登录状态；随后将跳转到个人任务列表`/my`；

#### 关于登录：

**(1)可直接使用已有账户：**

用户名：`kfc`

密码：`123456`

(2)或者自行创建账户，路由为：`/adduser`，随后可用创建的账户进行登录：

## 2.获取个人待办事项

如果输入的用户名和密码正确且登录成功，会**自动跳转**到个人待办事项列表页面`/my`。

登录失败，会显示相应的错误提示信息。

## 3.添加待办事项

1. 在个人事项列表页面`/my`，点击添加待办事项的按钮add，将跳转到addTodo界面`/addtodo`。
2. 输入待办事项的内容。（此时任务完成状态默认Uncompleted，且不可选中）
3. 点击添加按钮Save。

## 4.更改待办事项

1. 在个人事项列表页面`/my`，找到需要更改状态的待办事项。
2. 点击待办事项的Edit按钮，跳转到更改事项的页面 `edit-todo/{id}`。

这里包括三个功能点：

- 获取事项详细信息（包含用户验证）；
- 保存更改，跳转到个人事项页面`/my`，待办事项的状态应该会更新，例如从未完成变为已完成，或者反之。
- 取消更改，将会跳转回 待办事项列表页面；

（如果更改状态失败，应该会显示相应的错误提示信息。）



# 三、接口文档

## 1. 用户登录

- **URL**: `/user/login`
- **Method**: `POST`
- **请求参数**:
  - `username` (string): 用户名
  - `password` (string): 密码

将 验证用户名和密码；生成并返回token；

## 2.获取个人待办事项

- **URL**: `/list/my`
- **Method**: `GET`
- **请求头携带token**

> 解析token获取用户id，根据用户id获取个人事项列表并返回；

## 3. 添加待办事项

- **URL**: `/list/add`
- **Method**: `POST`
- **请求参数**:
  - `todoData` (Todolist对象): 待办事项信息

## 4. 更改待办事项状态

> 这里会先验证用户权限，验证通过获取到该事项详细信息，最后再实现更新

1. 获取事项信息

- **URL**: `/list/edit-todo/:id`
- **Method**: `GET`
- **请求参数**:
  - `id` (string): 待办事项ID
  - 请求头携带token

2. 更新事项信息

- **URL**: `/list/edit-todo/:id`
- **Method**: `PUT`
- **请求参数**:
  - `id` (string): 待办事项ID
  - `todoData`(Todolist):事项详细信息
  - 请求头携带token