# boo-admin_monorepo

**Repository Path**: monkey-open-source/boo-admin_monorepo

## Basic Information

- **Project Name**: boo-admin_monorepo
- **Description**: 一个基于 Vue 3 + Vite + TypeScript 构建的现代化 Monorepo 项目，采用标准的三层架构设计，提供传统后台管理系统和数据大屏展示多应用解决方案。
- **Primary Language**: JavaScript
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-25
- **Last Updated**: 2026-01-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 暗夜阁后台管理系统

基于 Vue 3 + TypeScript + Element Plus 的现代化后台管理系统，采用 Monorepo 架构开发。

## 📋 项目简介

暗夜阁后台管理系统是一个功能完整、开箱即用的企业级后台管理解决方案。系统包含了用户管理、角色管理、权限管理、系统监控等常用功能模块，适合快速搭建中后台产品。

## ✨ 主要特性

- 🚀 **Vue 3** - 采用最新的 Vue 3 Composition API
- 💪 **TypeScript** - 完整的类型系统支持
- 🎨 **Element Plus** - 基于 Element Plus UI 组件库
- 📦 **Monorepo** - pnpm workspace 管理多包项目
- 🌍 **国际化** - 内置中英文双语支持
- 🎯 **主题切换** - 支持亮色/暗色主题切换
- 📱 **响应式布局** - 适配不同尺寸屏幕
- 🔐 **权限管理** - 完整的 RBAC 权限控制
- 📊 **系统监控** - 服务器性能实时监控
- 📝 **操作日志** - 完整的操作和登录日志

## 🏗️ 技术栈

- **前端框架**: Vue 3.4+
- **开发语言**: TypeScript 5.3+
- **构建工具**: Vite 5.0+
- **UI 组件库**: Element Plus
- **包管理器**: pnpm 10+
- **路由管理**: Vue Router 4
- **状态管理**: Pinia (可选)
- **CSS 预处理**: 原生 CSS + CSS Variables

## 📁 项目结构

```
moon-boo-admin/
├── apps/                    # 应用目录
│   └── admin/              # 后台管理应用
│       ├── src/
│       │   ├── views/      # 页面组件
│       │   ├── router/     # 路由配置
│       │   ├── App.vue     # 根组件
│       │   └── main.ts     # 入口文件
│       └── package.json
├── packages/               # 公共包目录
│   ├── ui-kit/            # UI 组件库
│   ├── locales/           # 多语言配置
│   ├── utils/             # 工具函数
│   ├── assets/            # 静态资源
│   ├── router/            # 路由工具
│   └── shared-types/      # 共享类型
├── pnpm-workspace.yaml    # pnpm 工作空间配置
└── package.json           # 项目配置
```

## 🚀 快速开始

### 环境要求

- **Node.js**: 16.0 或更高版本
- **pnpm**: 8.0 或更高版本

### 安装依赖

```bash
# 安装 pnpm (如果还没有安装)
npm install -g pnpm

# 安装项目依赖
pnpm install
```

### 启动开发服务器

```bash
# 启动后台管理系统
pnpm --filter @moon-boo/admin dev

# 或者在项目根目录执行
cd apps/admin
pnpm dev
```

启动成功后，访问 [http://localhost:5173](http://localhost:5173)

### 构建生产版本

```bash
# 构建所有包
pnpm build:packages

# 构建后台管理应用
pnpm --filter @moon-boo/admin build

# 或者
cd apps/admin
pnpm build
```

### 预览生产版本

```bash
cd apps/admin
pnpm preview
```

## 📦 包管理

本项目使用 pnpm workspace 管理 Monorepo 架构，主要包含以下包：

- `@moon-boo/admin` - 后台管理应用
- `@moon-boo/ui-kit` - UI 组件库
- `@moon-boo/locales` - 多语言配置
- `@moon-boo/utils` - 工具函数库
- `@moon-boo/assets` - 静态资源
- `@moon-boo/router` - 路由工具
- `@moon-boo/shared-types` - 共享类型定义

### 构建某个包

```bash
# 构建 UI 组件库
cd packages/ui-kit
pnpm build

# 构建多语言包
cd packages/locales
pnpm build
```

## 🎯 功能模块

### 系统管理
- ✅ 用户管理 - 用户增删改查、角色分配
- ✅ 角色管理 - 角色权限配置
- ✅ 部门管理 - 组织架构管理
- ✅ 菜单管理 - 动态菜单配置
- ✅ 字典管理 - 系统字典维护
- ✅ 日志管理 - 操作日志、登录日志
- ✅ 参数配置 - 系统参数设置
- ✅ 通知公告 - 系统公告发布
- ✅ 定时任务 - Cron 任务管理
- ✅ 文件管理 - 文件上传下载
- ✅ 在线用户 - 在线用户监控

### 监控与运维
- ✅ 系统监控 - CPU、内存、磁盘监控
- ✅ 接口文档 - Swagger/Knife4j 文档

### 安全管理
- ✅ 黑名单管理 - IP/用户黑名单
- ✅ 敏感词管理 - 敏感词过滤

### 其他功能
- ✅ 操作指南 - 系统使用帮助
- ✅ 版本管理 - 版本信息展示
- ✅ 锁屏功能 - 支持密码保护的锁屏 (Ctrl+Alt+L)

## 🔧 开发指南

### 添加新页面

1. 在 `apps/admin/src/views` 下创建页面组件
2. 在 `apps/admin/src/router/index.ts` 中配置路由
3. 在 `apps/admin/src/App.vue` 中添加菜单项

### 使用 UI 组件

```vue
<template>
  <UniversalDisplayTable
    :config="tableConfig"
    :data="tableData"
    :pagination="pagination"
    @query="handleQuery"
  />
</template>

<script setup lang="ts">
import { UniversalDisplayTable } from '@moon-boo/ui-kit/admin'
</script>
```

### 多语言配置

在 `packages/locales/src` 下添加或修改多语言配置：

```typescript
// zh-CN/index.ts
export default {
  common: {
    confirm: '确认',
    cancel: '取消'
  }
}
```

## 🌐 浏览器支持

- Chrome >= 90
- Firefox >= 88
- Safari >= 14
- Edge >= 90

## 📄 许可证

[MIT License](LICENSE)

## 🤝 贡献

欢迎提交 Issue 和 Pull Request！

## 📞 联系方式

- 项目地址: [Gitee](https://gitee.com/monkey-open-source/boo-admin_monorepo)
- 问题反馈: [Issues](https://gitee.com/monkey-open-source/boo-admin_monorepo/issues)

## 📝 更新日志

### v1.1.0 (2026-01-02)

- ✨ 新增锁屏功能，支持快捷键 Ctrl+Alt+L
- ✨ 支持在设置中配置锁屏密码
- ✨ 锁屏状态持久化，刷新页面保持锁屏
- 🔗 完成 API 请求封装，全量 TypeScript 类型定义
- 🔑 实现自动 Token 管理和携带机制
- 🌍 集成所有系统管理 API（菜单、角色、用户、部门、字典、配置、通知）
- 📝 生成完整的 API 接口文档 (api.md)

### v1.0.0 (2025-12-29)

- 🎉 完成基础框架搭建
- ✨ 实现系统管理模块
- ✨ 实现监控与运维功能
- ✨ 实现安全管理功能
- 🌍 集成多语言支持
- 🎨 实现主题切换功能
- 📦 搭建 Monorepo 架构

---

**暗夜阁团队** ❤️ 用心打造