sf-nest-admin开源项目使用教程

1. 项目介绍

sf-nest-admin 是一款基于 NestJs、TypeScript、TypeORM、Redis、MySql、Vue2 和 Element-UI 编写的前后端分离的权限管理系统。该项目旨在为开发者提供一个简单高效的权限管理解决方案，帮助开发者快速构建企业级应用。

2. 项目快速启动

环境准备

• Node.js（建议使用 LTS 版本）
• npm 或 yarn
• MySQL
• Redis

克隆项目

git clone https://github.com/hackycy/sf-nest-admin.git

安装依赖

cd sf-nest-admin
npm install
# 或者
yarn install

配置数据库和Redis

在 src/config 目录下，根据实际环境修改 database.ts 和 redis.ts 文件中的配置。

启动项目

# 启动后端
npm run start
# 或者
yarn start

# 启动前端（Vue项目）
cd sf-nest-admin-web
npm run serve
# 或者
yarn serve

访问项目

• 后端接口：http://localhost:3000
• 前端页面：http://localhost:9528

默认账号密码：

• 账号：openadmin
• 密码：123456
• 权限：仅查询权限

3. 应用案例和最佳实践

模块化开发

sf-nest-admin 采用模块化开发，各模块相互独立，便于维护和扩展。开发者可以根据实际需求，轻松添加或删除模块。

权限管理

系统内置完善的权限管理功能，包括菜单权限、按钮权限等，可按角色分配权限，实现细粒度控制。

数据库迁移

使用 TypeORM 进行数据库迁移，轻松实现数据库版本的迭代和升级。

4. 典型生态项目

以下是 sf-nest-admin 生态中的一些典型项目：

• ark-admin-nest：基于 sf-nest-admin 改进的 Vue3 版本
• 其他相关项目

感谢您使用 sf-nest-admin，希望对您的项目有所帮助！