# xlt-admin-backend

**Repository Path**: wei_pengcheng/xlt-admin-backend

## Basic Information

- **Project Name**: xlt-admin-backend
- **Description**: Xlt-Admin是一个基于 Vue3.4、TypeScript、Vite5、Pinia、Element-Plus 开源的后台管理框架 和 nestjs 开发的全栈前后端分离的开发基础平台，集成jwt鉴权，动态路由，动态菜单，casbin鉴权，表单生成器，代码生成器等功能，提供多种示例文件，让您把更多时间专注在业务开发上。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-02-12
- **Last Updated**: 2025-09-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Xlt-Admin-Backend
## 项目概述
Xlt-Admin-Backend 是一个使用 NestJS 构建的后端项目，结合了 Casbin 进行权限控制，使用 Redis 作为缓存和 MySQL 作为数据库，提供 Xlt 平台的管理后台 API。

## 技术栈
- **NestJS**：一个渐进式的 Node.js 框架，用于构建高效且可扩展的服务器端应用。
- **Casbin**：一个强大的访问控制库，支持多种权限模型，如 ACL、RBAC、ABAC 等，用于权限管理。
- **Redis**：一个高性能的键值存储系统，作为缓存和会话存储，提升系统的性能。
- **MySQL**：关系型数据库管理系统，用于持久化存储数据。
- **TypeScript**：一种静态类型的 JavaScript 超集，帮助开发人员减少错误并提升代码质量。
- **JWT**：用于身份验证和授权的 JSON Web Tokens。
- **Docker**：容器化的后端服务，方便部署和扩展。

## 安装步骤

1. 克隆仓库：
   ```
   git clone https://github.com/your-username/xlt-admin-backend.git
   ```
2. 进入项目目录：
   ```
   cd xlt-admin-backend
   ```
3. 安装依赖：
   ```
   npm install
   ```
4. 配置 `.env` 文件，设置必要的环境变量（如数据库连接信息、Redis 配置、JWT 密钥等）。
5. 启动应用：
   ```
   npm run start:dev
   ```

## 使用 Docker 启动

1. 构建 Docker 镜像：
   ```
   docker-compose build
   ```
2. 启动应用：
   ```
   docker-compose up
   ```

## API 文档
API 文档通过 Swagger 自动生成，启动后可以访问以下地址查看：
```
http://localhost:3000/api
```

## 测试
运行测试：
```
npm run test
```

## 许可证
本项目使用 MIT 许可证。