nest-admin

# nest-admin **基于 NestJs + TypeScript + TypeORM + Redis + MySql + Vue3 + Ant Design Vue 编写的一款简单高效的前后端分离的权限管理系统。希望这个项目在全栈的路上能够帮助到你。** - 前端项目地址：[传送门](https://github.com/buqiyuan/vue3-antdv-admin) ## 演示地址

• https://vue3-antdv-admin.pages.dev/ （墙内） 只读，可以完整地预览项目的初始效果
• https://vue3-antd-admin.vercel.app/ （墙外）
  • 可随意 CRUD，所以你看到的数据可能已经被其他人修改过，而非项目得初始效果，并且数据库的数据会在每天凌晨 4.30 分重置一次。
  • 由于是白嫖的国外服务器资源，所以不保熟， 并可能还需要翻墙浏览。
• Swagger 文档

## 项目启动前的准备工作 - sql 文件：[/deploy/sql/nest_admin.sql](https://github.com/buqiyuan/nest-admin/tree/main/deploy/sql/nest_admin.sql) 用于数据库初始化 - 项目相关配置，如：配置 mysql 和 redis 连接 - 公共配置: [.env](https://github.com/buqiyuan/nest-admin/blob/main/.env) - 开发环境: [.env.development](https://github.com/buqiyuan/nest-admin/blob/main/.env.development) - 生产环境: [.env.production](https://github.com/buqiyuan/nest-admin/blob/main/.env.production) ## 环境要求 - `nodejs` `20`+ - `docker` `20.x`+ ，其中 `docker compose`版本需要 `2.17.0`+ - `mysql` `8.x`+ - 使用 [`pnpm`](https://pnpm.io/zh/) 包管理器安装项目依赖 演示环境账号密码： | 账号 | 密码 | 权限 | | :-------: | :----: | :--------: | | admin | a123456 | 超级管理员 | > 所有新建的用户初始密码都为 a123456 本地部署账号密码： | 账号 | 密码 | 权限 | | :-------: | :----: | :--------: | | admin | a123456 | 超级管理员 | ## 快速体验 启动成功后，通过 访问。 ```bash pnpm docker:up # or docker compose --env-file .env --env-file .env.production up -d --no-build ``` 停止并删除所有容器 ```bash pnpm docker:down # or docker compose --env-file .env --env-file .env.production down ``` 删除镜像 ```bash pnpm docker:rmi # or docker rmi buqiyuan/nest-admin-server:stable ``` 查看实时日志输出 ```bash pnpm docker:logs # or docker compose --env-file .env --env-file .env.production logs -f ``` ## 本地开发 - 获取项目代码 ```bash git clone https://github.com/buqiyuan/nest-admin ``` - 【可选】如果你是新手，还不太会搭建`mysql/redis`，你可以使用 `Docker` 启动指定服务供本地开发时使用, 例如： ```bash # 启动MySql服务 docker compose --env-file .env --env-file .env.development run -d --service-ports mysql # 启动Redis服务 docker compose --env-file .env --env-file .env.development run -d --service-ports redis ``` - 安装依赖 ```bash cd nest-admin pnpm install ``` - 运行 启动成功后，通过 访问。 ```bash pnpm dev ``` - 打包 ```bash pnpm build ``` ## 数据库迁移 1. 更新数据库(或初始化数据) ```bash pnpm migration:run ``` 2. 生成迁移 ```bash pnpm migration:generate ``` 3. 回滚到最后一次更新 ```bash pnpm migration:revert ``` 更多细节，请移步至[官方文档](https://typeorm.io/migrations) > [!TIP] > 如果你的`实体类`或`数据库配置`有更新，请执行`npm run build`后再进行数据库迁移相关操作。 ## 系统截图 ### 欢迎 Star && PR **如果项目有帮助到你可以点个 Star 支持下。有更好的实现欢迎 PR。** ### 致谢 - [sf-nest-admin](https://github.com/hackycy/sf-nest-admin) ### LICENSE [MIT](LICENSE)