快速开始
目录结构
├── bin # 脚本
│ │── build.sh # 部署构建脚本
├── config # 项目配置
│ │── index.ts # 配置文件
│ │── secret.ts # 密钥配置
├── deploy # cmd-deploy 自动化部署
│ │── deploy.config.mjs # 自动化部署配置
├── doc # 项目文档
│ │── sql # sql 脚本
│── dist # 构建目录
├── src # 源代码
│ ├── common # 公共文件
│ ├── modules # 系统模块
│ ├── modulesBusi # 业务模块
│ ├── app.controller.spec.ts # 测试用例
│ ├── app.controller.ts # 根路由
│ ├── app.module.ts # 根模块
│ ├── app.service.ts # 根服务
│ ├── main.ts # 入口文件 加载组件 初始化等
├── test # 测试脚本
├── upload # 文件上传存储目录
├── LICENSE # LICENSE文件
├── .prettierrc # prettier格式化配置
├── package.json # package.json
├── README.md # README
├── RELEASE.md # 发布日志
├── tsconfig.json # tsconfig 配置安装
本地需要提前安装 nodejs v20+
bash
# clone 项目
git clone https://gitee.com/nestts/nestjs-admin.git
# 进入项目根目录
cd nestjs-admin
# 安装依赖
# 方式一： npm 指定淘宝镜像
npm i --registry=https://registry.npmmirror.com
# 方式二： 使用 cnpm 安装
npm install -g cnpm --registry=https://registry.npmmirror.com
cnpm i
# 方式三： npm i 原始安装 国内推荐上述两种方式 DDDD(懂的都懂)
npm i配置与准备
- 系统使用mysql数据库，在
config/index.ts里的env.dev.database中配置本地mysql数据库连接信息，在env.prod.database中配置生产数据库连接信息。
如果需要自定义其他环境配置，可以在config/index.ts文件中添加对应环境配置，例如：env.test.database，同时在package.json的scripts中配置对应的命令脚本环境变量模式，如npm run start:test。 - 创建
nest_admin数据库，执行doc/sql/nest_admin.sql文件，创建表到该数据库中 - 执行
doc/sql文件夹下的其他sql 文件，导入对应表、系统基础数据到数据库中 - 安装Redis，并启动，具体可参考官方文档
运行
bash
# 本地开发
$ npm run dev
# 或
$ npm run start:dev
# 线上运行
$ npm run start:prod在应用程序运行后, 打开浏览器并访问 http://localhost:3000/。 你应该看到 Hello world! 信息。可以配合前端项目看到整体运行效果。