快速开始
项目环境
- git
- Node >= v20 or later
- pnpm >= v9 or later
- mysql >= v8 or later
- redis >= v7 or later
开发工具推荐
- VSCode
- Cursor
代码获取
bash
git clone https://gitee.com/mrzym/nest-admin.gitmaster 分支 http 框架使用 express，fastify 分支 http 框架使用 fastify，根据实际应用场景选择分支，express 比较常用，fastify 性能更高。
安装 mysql 和 redis
mysql
https://dev.mysql.com/downloads/
redis
项目配置
参考：配置
本地运行项目
先完善基础配置才能运行项目
bash
# 进入项目目录
cd nest-admin
# 安装依赖
pnpm install
# dev 环境运行项目
pnpm start:dev启动后，终端内输入运行日志，并且没有报错，则表示项目启动成功
访问 http://localhost:3000 即可访问 nest-admin
访问 http://localhost:3000/docs 即可访问 nest-admin 接口文档
Docker 运行
本地需安装 Docker 客户端
DockerDesktop 安装后自带 docker 和 docker-compose 命令，无需额外安装
项目内配置了 docker-compose.yml 文件，包含 nest-admin、mysql、redis 等服务，无需额外配置环境，直接构建镜像并运行即可
如果本地没有 mysql、redis，可以直接运行，当前的配置是没有问题的。如果本地有 mysql、redis，需要修改配置文件(.env.development、docker-compose.yml)内的数据库、redis 账户密码、端口号等，防止和本地的 mysql、redis 冲突，导致运行失败
bash
docker-compose build # 构建镜像
docker-compose up -d # 运行容器启动后，可以在 Docker Desktop 中查看各个容器的运行状态、运行日志，如果容器都运行成功，则表示项目启动成功
可以在 Docker 日期管理旁边点击链接访问项目
也可以访问 http://localhost:3000