🔧 数据库调试改为本地进行了。

Author: langyo

Makefile.toml

@@ -10,7 +10,7 @@ exec docker build -t kongying-tavern-backend .
 '''
 
 [tasks.dev]
-env_files = ["./.env"] # 密码需要自行创建 .env 文件，并写入 DB_PASSWORD 变量，仓库本身不保存也不能保存任何密码
+env_files = ["./.env"]
 watch = { no_git_ignore = true, ignore_pattern = "Cargo.lock", watch = [
   "./packages/",
 ] }
@@ -22,8 +22,8 @@ exec cargo run
 '''
 
 [tasks.dev.env]
-DB_HOST = "ddns.minemc.top"
-DB_PORT = "13432"
+DB_HOST = "127.0.0.1"
+DB_PORT = "5432"
 DB_USERNAME = "genshin_map"
 DB_DATABASE = "genshin_map"
 

ReadMe.md

@@ -1,88 +1,39 @@
-# 空荧酒馆·原神地图 Rust 后端
+# 空荧酒馆·原神地图 Rust 后端 / Genshin Map Cloud Rust Backend
 
-## 如何构建
+## 如何构建 / How to build
+
+为了确保环境的一致性，本项目采用 Docker Compose 进行自动化部署。请确保机器上已安装 Docker 和 Cargo。
 
 To ensure the environment is unified, this project has been deployed automatically using Docker Compose. Make sure Docker and Cargo are installed on the machine.
 
+在部署之前，您应该在项目文件夹中创建一个名为 `.env` 的文件，其中存储服务器将连接到的数据库的配置信息。示例内容如下：
+
 Before the formal deployment, you should create a file named `.env` in the project folder, which stores the configuration information of the database that the server will connect to. The example content is as follows:
 
 ```env
-MARIADB_ROOT_PASSWORD=root
-DB_PASSWORD=root
+DB_PASSWORD=<password>
 ```
 
+请确保以上的配置项已正确填写。
+
 Please make sure that the configuration file has correctly filled in all the keys involved in the above example, and cannot be omitted.
 
-Before starting, please make sure that `cargo-make` is installed:
+正式开始前，请确保已安装 `cargo-make` 与 `docker`；如果需要本地调试，还需要安装 `docker-compose`。
 
-```bash
-cargo install --force cargo-make
-```
+Before starting, please make sure that `cargo-make` and `docker` are installed. If you need local debugging, you also need to install `docker-compose`.
+
+之后，执行以下命令以构建集群：
 
 Then execute the following command in the project directory to build the cluster:
 
 ```bash
 cargo make build
 ```
 
+如果您需要实时调试，可以通过以下方式启动集群：
+
 If you need to debug in real time, start the cluster in this way:
 
 ```bash
 cargo make dev
 ```
-
-While deploying to the server, there are some differences in the way the cluster starts:
-
-```bash
-cargo make -p production -e DB_USERNAME=<username> -e DB_PASSWORD=<password> up
-# Or use the .env file to keep the password on the server,
-# ensuring that the password itself does not appear in the terminal execution history
-cargo make -p production --env-file=<filepath> up
-```
-
-## 逻辑分块
-
-主要分为3大块：
-
-1. 业务模块
-2. 权限模块
-3. 功能模块
-
-### 业务模块
-
-业务模块为服务于地图逻辑的模块
-
-当前提供的地图逻辑实体有：
-
-1. 地区
-2. 物品
-3. 点位
-4. 图标
-5. 路线
-
-其中，对以下逻辑实体提供打点-审核机制：
-
-1. 点位
-2. 路线（TODO）
-
-对以下逻辑实体提供分类支持：
-
-1. 物品
-2. 图标
-
-以下的数据结构为树状结构：
-
-1. 所有的分类
-2. 地区
-
-### 权限模块
-
-当前权限系统为单角色，共分为以下几个等级（权限由高到低）
-
-1. 系统管理员——最高权限，管理权限模块
-2. 地图管理员——管理业务模块
-3. 审核员——拥有审核点位的权限
-4. 测试服打点员——拥有对测试服数据的访问权限，经管理员授权可以绕过审核机制
-5. 正式服打点员——拥有提交打点的权限
-6. 后台准用户——无权限
-7. 前台用户——匿名用户

dev.compose.yml

@@ -1,6 +1,20 @@
-# 请注意，该集群配置**不是**生产环境配置，只用于本地测试环境
+# Attention: This cluster configuration is **not** for production use!
+# 注意：该集群配置**不是**生产环境配置！
 
 services:
+  postgres:
+    image: postgres:latest
+    container_name: test-postgres
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: genshin_map
+      POSTGRES_PASSWORD: genshin_map
+      POSTGRES_DB: genshin_map
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    restart: unless-stopped
+
   redis:
     image: redis:latest
     container_name: test-redis
@@ -36,6 +50,7 @@ services:
   #   restart: unless-stopped
 
 volumes:
+  postgres-data:
   redis-data:
   minio-data:
   # alist-data: