增加readme文件

2025-05-12 15:09:24 +08:00
parent 0792992cc7
commit a3f51dee7d
1 changed files with 92 additions and 0 deletions
@@ -0,0 +1,92 @@
+# ICP(Intelligence Control Platform)
+
+## 简介
+
+项目使用Vue作为前端、Ktor作为后端，PostgreSQL作为数据库进行部署。
+
+## 部署
+
+### 后端
+
+1. 将Ktor程序运行installDist打包程序。
+
+2. 将程序覆盖于服务器/opt/final/ktor文件夹
+
+3. 将项目目录server/service的ktor.service文件置于服务器/etc/systemd/system/目录
+
+4. 输入命令使服务开机自启
+   ```shell
+   sudo systemctl enable ktor.service
+   sudo systemctl status ktor.service
+   ```
+
+### 前端
+
+1. 在vue目录运行docker打包命令
+   ```shell
+   pnpm bulid:docker
+   ```
+
+2. 将Image保存为文件
+   ```
+   docker save -o vue.tar ce-vue
+   ```
+
+3. 将保存好的Image`vue.tar`上传到服务器
+
+4. 在服务器读取Image
+   ```shell
+   docker load -i vue.tar
+   ```
+
+### Docker Compose
+
+包含Vue、PostgreSQL、Radis、MinIO在内的Docker Compose服务
+
+1. 将项目目录下的`server/docker-compose.yml`复制到服务器
+
+2. 运行Docker Compose
+   ```shell
+   docker compose up -d
+   ```
+
+## 其他
+
+### Vue项目使用
+
+1. 本地运行dist文件夹
+   ```shell
+   npm install -g http-server
+   cd dist
+   http-server -p 8080
+   ```
+
+2. VBen项目运行方法
+
+   1. 下载最新node
+
+   2. 开发
+
+      ```shell
+      # 进入项目目录
+      cd vue-vben-admin
+      
+      # 使用项目指定的pnpm版本进行依赖安装
+      npm i -g corepack
+      
+      # 安装依赖
+      pnpm install
+      # 启动项目
+      pnpm dev
+      ```
+
+   3. 本地部署
+      ```shell
+      构建
+      pnpm build
+      
+      预览
+      pnpm preview
+      ```
+
+