NestJS Admin 安装与使用指南
目录结构及介绍
NestJS Admin 的项目结构主要分为以下几个部分:
-
client
: 前端目录, 包含了 Vue.js 构建的 UI 部分.- 内部可能包含了各种组件、页面以及状态管理代码.
-
db
: 数据库脚本或模型存放位置.- 可以找到用于数据库表结构设计的 SQL 脚本或 ORM 映射定义.
-
docs
: 文档目录, 提供项目相关的使用指南和API文档.- 这里会有关于如何部署、配置项目的详细指导.
-
server
: 后端服务目录, 主要由 NestJS 和 TypeORM 构成.- 包括业务逻辑、REST API 接口和数据访问层.
-
upload
: 文件上传处理相关的资源目录.- 用于存储如图片、附件等上传文件.
此外, 还有几个重要的非目录文件:
.gitattributes
,.gitignore
: Git 版本控制的相关配置.LICENSE
: 项目的许可协议声明.README.md
: 项目描述性文档, 包含了一键安装方法和基本功能介绍.docker-compose-restart.sh
,docker-compose.yml
: Docker Compose 配置, 便于容器化部署.package.json
,pnpm-lock.yaml
: Node.js 项目依赖管理和锁定文件.
启动文件介绍
前端启动 (client
)
进入 client
目录:
cd client/
安装依赖
npm i
# 或者
pnpm install
本地运行
npm run dev
# 或者
pnpm dev
这将开启一个本地开发服务器, 并可以访问应用界面。
后端服务 (server
)
确保已经准备好了 MySQL 和 Redis 环境. NestJS Admin 使用 TypeORM 来连接MySQL数据库。
安装与构建
cd server/
pnpm install
# 构建步骤, 对于TypeScript项目是必要的
pnpm build
启动服务
pnpm start
或者使用以下命令来开发环境下运行:
pnpm dev
这将会启动 NestJS 服务并监听来自数据库的变化。
数据库迁移
首次使用时, 需要创建数据库表结构。可以通过以下命令来完成:
cd server/
# 创建新的迁移文件
pnpm migration:generate
# 应用最新的迁移更新 (即创建数据库表)
pnpm migration:run
如此一来, 就完成了整个系统的初始化设置。
配置文件介绍
NestJS Admin 中的配置文件主要是位于 server
目录下的 .env
文件, 它负责定义环境变量,比如:
DATABASE_HOST
: 数据库主机地址DATABASE_NAME
: 数据库名称DATABASE_USER
: 登录数据库的用户名DATABASE_PASSWORD
: 登录数据库密码REDIS_URL
: Redis 缓存服务器的URL- 其他如JWT密钥、端口设置、静态资源路径等关键参数。
为了安全起见, 这些值不应该直接写入代码, 而是在 .env
文件中设定。这样既保证了灵活性也维护了安全性。
这些环境变量会被 NestJS 自动读取, 在各个模块中按需注入使用。正确地配置这些参数对于系统正常运行至关重要。
最后, 不可忘记查看项目文档以获取更全面的信息和支持。如果有任何疑问或需要进一步的帮助, 项目仓库中的 文档 部分会提供详细的解答。