# online-forum

**Repository Path**: study_less_shape/online-forum

## Basic Information

- **Project Name**: online-forum
- **Description**: 毕设项目，基于rust和vue的前后端分离的论坛
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-05-07
- **Last Updated**: 2023-07-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 使用 Rust 和 Vue 实现的论坛网站
## 禁止商用！禁止拿来盈利！

## 前端
- [vue](https://cn.vuejs.org/)：没什么好说的，强大的前端框架
- [Bootstrap](http://getbootstrap.com/)：很好用的前端布局框架
- [element-plus](https://element-plus.gitee.io/zh-CN/)：vue的ui框架，非常好用
- [md-editor-v3](https://imzbf.github.io/md-editor-v3/)：基于 vue3 的 markdown 编辑器

## 后端
- [rust](https://www.rust-lang.org/zh-CN/)：主要使用了 [actix-web](https://actix.rs/) 框架，其他用到的都在 [cargo.toml](./backend/Cargo.toml) 里

> 后端和前端依赖的所有的库都可以从[这里](https://github.com/studylessshape/online-forum/network/dependencies)查看，包含了不少没有直接使用的库，所以比较多也比较杂，前端看 [package.json](./frontend/package.json)比较好，后端则是 [cargo.toml](./backend/Cargo.toml)。

## 数据库
数据库使用的 [mysql](https://www.mysql.com/cn/)。

样例数据库表和数据的导入请运行 [database.sql](./doc/database.sql)。

## 前后端交互
使用跨域通信

## 配置文件
### 后端
如果运行时没用配置文件，则会自动创建一个配置文件，并且会提示配置好邮件发送服务的账户密码和服务器，如下所示。
```
[2023-05-08T08:05:15Z INFO  backend] Read config file......
[2023-05-08T08:05:15Z WARN  backend] Please config your email and password in file `server.conf.toml`
```

所以如果不清楚配置文件内容，可以尝试运行一次，再对配置文件进行配置。

配置文件解析：

```toml
# 后端启动后，监听的端口
port = 8082
# 后端跨域请求中，允许给后端发送请求的服务器地址，默认为 `[]`，即允许所有外域。
# 建议添加指定的外域地址，否则将无法接收来自请求的 `Credentials` 信息
allow_origins = []
# 跨域请求允许的方法，设置为 `[]` 为允许所有请求方法
allow_methods = ["GET", "POST"]
# 设置管理员账户的密码
admin_password = "123456789"

[email_account]
# 用户注册、更改密码、忘记密码时，会用一个邮箱来给用户发送验证码，此处配置的是能够通过 SMTP 服务器发送邮箱的账户和密码
# 如本人用的是微软的 outlook 邮箱来发送验证码邮件，则 smtp_server 处应为
email = ""
password = ""
smtp_server = "smtp.office365.com"

# 数据库使用的是 mysql
[database_config]
# 数据库登录账户和密码
name = ""
password = ""
# 数据库所在 ip 或域名
ip_or_host = "localhost"
# 端口
port = 3306
# 使用的数据库名
db_name = "online_forum"
```

**注意：**
1. `allow_origins` 处建议添加指定的外域地址，否则将无法接收来自请求的 `Credentials` 信息；
2. 添加的外域地址，尽量不要在尾部加上 `/`，否则可能会导致拒绝外域服务器的请求。

参考配置：
```toml
port = 8082
allow_origins = ["http://localhost:5173", "http://localhost", "http://192.168.187.24"]
allow_methods = ["POST", "GET"]
admin_password = "123456789"

[email_account]
email = "*@outlook.com"
password = "*"
smtp_server = "smtp.office365.com"

[database_config]
name = "admin"
password = "123456789"
ip_or_host = "localhost"
port = 3306
db_name = "online_forum"
```

### 前端配置
前端的配置文件为 `config.js`，在开发环境中，位于 `public` 文件夹下。打包后，应和 `index.html` 位于同一文件夹。配置的内容应和后端服务器部署的地址一致。

配置文件内容即参考配置：
```js
window.server = {
    // 服务器使用的协议
    protocol: "http",
    // 服务器地址或域名
    host: "localhost",
    // 服务器端口，可以为 null
    port: 8082,
};
```

**注意：**

后端对外域来源非常敏感，如果后端配置的外域为地址或域名为 `localhost`，而前端配置的 `host` 为本机的 ip 地址（即非 `localhost` 和 `127.0.0.1`），那么后端在收到跨域请求时，容易出现无法得到 `Cookie` 的情况。

## 启动
前面的配置如果没有问题，则可以尝试启动程序。

建议先启动后端。启动指令如下：
```sh
cargo run
```

启动时，会提示管理员用户的账户密码。如果配置有错误，在控制台中也会有相应的提示。

然后启动前端。前端启动方式较多，这里仅提供 `vite` 启动：
```sh
npm install
npm run dev
```

前端启动后，会提示一个链接，打开这个链接进入前端，就可以开始使用了。