!!!注意!!!

本项目现已整合至以下仓库，今后的所有更新与维护工作都将在此新仓库中进行。敬请关注新仓库的最新动态。

• https://github.com/fyade/ms
• https://gitee.com/fyade/ms

关于

这是一个后台管理系统模板，前端语言为 Vue.js（Vue3），后端语言为 Nest.js，建议 Node 版本：20.12.0。

版本建议：

• Node 20.12.0
• MySQL 8
• Redis 较新版本皆可

前端开源地址：

• https://github.com/fyade/ms-frontend-admin 请关注新仓库
• https://gitee.com/fyade/ms-frontend-admin 请关注新仓库

后端开源地址：

• https://github.com/fyade/ms-backend 请关注新仓库
• https://gitee.com/fyade/ms-backend 请关注新仓库

二开注意事项

• sys_sys 及 sys_menu 表中，您二开时产生的系统及菜单的 id，建议从 10001 开始，否则可能会与本项目后续产生的新数据冲突；
• 本项目中未对 DTO、VO、POJO、ENTITY 等做区分，均使用 DTO；

运行教程

若非初次运行，可直接 npm run start:dev 运行，然后下面步骤可忽略。

1. 从仓库中拉取项目

git clone https://github.com/fyade/ms-backend.git

2. 配置

在 /config 目录下新建 config.ts 文件，然后将 config.txt 内的内容复制进去并根据自身情况做修改；

在根目录下新建 .env 文件，然后将以下内容复制进去，并根据自身情况做修改：

# Environment variables declared in this file are automatically made available to Prisma.
# See the documentation for more detail: https://pris.ly/d/prisma-schema#accessing-environment-variables-from-the-schema

# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
# See the documentation for all the connection string options: https://pris.ly/d/connection-strings

DATABASE_URL="mysql://root:123456@localhost:3306/table_name"

3. 初始化数据库

运行 npx prisma migrate dev --name init 命令；

4. 接下来

若未全局安装 nest，则先需要全局安装 nest，命令为 npm i -g @nestjs/cli；

其次下载项目依赖，命令为 npm i；

然后还需要向部分表中插入初始数据，初始数据位于 /bin/sql.sql；

随后需要插入一个初始用户，步骤如下：

4.1 打开 api 工具，调用 /sys/user/regist 接口，请求方法为 POST，content-type 为 application/json，请求体参数如下，其中 username 和 password 改成管理员的用户名和密码、psdType 勿更改、loginRole 勿更改；

{
  "username": "username",
  "password": "password",
  "psdType": "a",
  "loginRole": "admin"
}

4.2 随后发送请求，请求成功后，打开数据库管理软件，打开 sys_user 表，复制刚注册的用户的 id 字段；

4.3 打开 sys_admin_top 表，添加一条记录，其中 user_id 为刚复制的 id，deleted 为字符 N，其他随意；

4.4 至此，刚才注册的用户就成为了至高无上的超级管理员；

4.5 最后，使用 npm run start:dev 命令启动项目；

打包教程

注意：以生产环境为例子：在 config.ts 中有一个变量，叫 config，其第一个键为 dev，表示开发环境的配置，接下来你需要加一个键 prod，表示生产环境的配置，然后你需要把 dev 的值复制进去并修改为生产环境的配置。

1. 将 /prisma/schema/schema.prisma 中的 generator client.output （第9行）配置为 '../../generated/client'；

2. 运行 npx prisma generate 命令，然后将 /generated 目录复制至 生产环境根目录 /generated；

3. 运行 npm run build:wp 命令，然后将 /dist 目录复制至 生产环境根目录 /dist；

4. 在 node_modules 文件夹中，找到 svg-captcha 文件夹，然后将文件夹内 /fonts 目录复制至 生产环境根目录 /fonts；

5. 运行 $env:NODE_ENV="prod"; node .\dist\main.js 命令，其中 NODE_ENV 是命令行变量，在不同系统、不同命令行工具中写法可能不一样，请根据自身情况修改。

修改数据库结构

1. 在 /prisma/schema/ 目录下的 .prisma 文件中定义数据库结构；

2. 在 .env 文件中定义数据库地址，随后运行 npx prisma migrate dev --name gx 命令。

将数据库结构同步至生产环境

在 /prisma/migrations/ 目录下，有每次运行迁移命令时产生的 sql 文件，找到对应文件，在生产环境运行即可。

命令

启动命令：

$env:NODE_ENV="dev"; node ./main.js

其他命令：

初始化 prisma：

npx prisma init

prisma 迁移数据库：

$ npx prisma migrate dev --name gx

prisma 重置数据库：

$ npx prisma migrate reset

prisma 生成 Prisma Client：

$ npx prisma generate

nest 生成拦截器：

$ nest generate interceptor auth-token

nest 创建模块：

$ nest g mo module/name # 创建一个用户模块
$ nest g co module/name --no-spec # 创建不带测试文件的控制器
$ nest g s module/name --no-spec # 创建不带测试文件的服务层

nest 创建管道：

$ nest g pipe validation pipe # 管道

其他注意事项

菜单相关常量：

• mm 表示菜单
• mc 表示组件
• ma 表示接口组
• mb 表示接口

菜单 ip 限制相关常量：

• ip 表示 ip
• ho 表示 host

权限身份类型相关常量：

• ro 表示角色
• de 表示部门
• ug 表示用户组

数据表行(háng)权限管理相关常量：

• ALL 表示全部
• SELF_DEPT 表示本部门
• DEPT_ONE_SON 表示本部门及直属子部门
• DEPT_ALL_SON 表示本部门及全部子部门
• SELF_ROLE 表示本角色
• SELF 表示自己

许可证

GNU GPLv3

License file name in this project: COPYING

Copyright (c) 2024-present, Fei Yang