# solf-admin

**Repository Path**: solfKwolf/solf-admin

## Basic Information

- **Project Name**: solf-admin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-28
- **Last Updated**: 2026-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

```markdown
# Solf-Admin

基于 NestJS 的后台管理系统框架，提供完整的权限控制、日志记录、任务调度等企业级功能。

## 项目说明

Solf-Admin 是基于 NestJS 开发的企业级后台管理框架，适用于快速构建具备完整权限管理、日志记录、任务调度等功能的企业级应用。

## 项目结构

- **src/common**：包含通用组件、装饰器、工具类等。
- **src/modules**：各功能模块，包括系统管理、监控、通用功能等。
- **src/config**：配置文件。
- **src/main.ts**：项目入口文件。

## 安装

确保已安装 Node.js 和 npm，然后运行：

```bash
$ npm install
```

## 启动项目

```bash
# 开发模式
$ npm run start

# 监听模式
$ npm run start:dev

# 生产模式
$ npm run start:prod
```

## 测试

```bash
# 单元测试
$ npm run test

# 端到端测试
$ npm run test:e2e

# 测试覆盖率
$ npm run test:cov
```

## 功能模块

- **系统管理**：用户管理、角色权限、菜单配置、部门管理、岗位管理、字典管理等。
- **监控管理**：操作日志、登录日志、定时任务管理。
- **通用功能**：文件上传、Redis 缓存、Axios 请求封装。
- **备份模块**：提供数据备份相关功能。

## 核心功能

- 基于 JWT 的身份认证与权限控制。
- 多种装饰器支持权限验证、操作日志记录、Redis 缓存等。
- 支持角色权限控制、动态菜单生成。
- 提供系统监控功能，包括操作日志、登录日志、任务调度日志。
- 支持通用数据导出、验证码生成等功能。

## 配置

- 配置文件位于 `src/config/`，支持不同环境的配置（如开发、测试、生产）。
- 数据库配置、Redis 配置、JWT 密钥等可在配置文件中修改。

## 部署

项目可部署在支持 Node.js 的环境中。推荐使用 Docker 容器化部署，也可使用 PM2 等进程管理工具进行生产部署。

## 技术栈

- **NestJS**：基于 TypeScript 的 Node.js 框架。
- **TypeORM**：ORM 框架，用于数据库操作。
- **JWT**：用于身份验证和权限控制。
- **Redis**：用于缓存和会话管理。
- **Swagger**：API 文档生成工具（如使用）。
- **Axios**：HTTP 请求封装。
- **装饰器模式**：实现权限控制、日志记录等功能。

## 贡献

欢迎提交 PR 或 Issue，帮助完善项目功能和文档。

## 许可证

本项目采用 MIT 许可证。
```