Skip to content

Repository files navigation

PbstarAdmin Logo

PbstarAdmin 微后台🎉

基于 wujie 微前端 + rsbuild 高性能构建 + pnpm monorepo 的现代化架构
集成 Vue3 + TypeScript + Pinia + Element Plus 主流技术体系,提供从开发到部署的完整解决方案

官方文档 在线演示 WeChat

✨ 项目特点

  • 🚀 微前端架构: 基于腾讯 wujie 微前端框架,主子应用经共享 Pinia + wujie bus 同步状态,实现应用级解耦
  • 📦 智能模块化: pnpm monorepo 工作区管理,支持内外部子应用(in/out类型),外部子应用可独立 git 仓库管理
  • 🧩 企业级组件化: 共享组件库设计,@Pcomponents、@Passets 统一别名引用,支持跨应用组件复用
  • 🔐 统一权限模型: 菜单与按钮合并为统一权限模型,后端权限 key 驱动菜单与按钮显隐
  • ⚙️ 全链路工程化: 完整 CLI 工具链(create/dev/build/add/remove/check),自动化脚手架、依赖管理、打包部署
  • ⚡ 极致现代化: 全量 TypeScript,基于 Rsbuild 高性能构建,多环境配置,支持子应用独立开发、调试、打包

📋 环境要求

  • node >= 20.19.0(推荐使用 Node.js 22 LTS)
  • pnpm >= 9.15.0

🚀 快速开始

# 克隆项目
git clone https://github.com/pbstar/pbstar-admin.git
# 进入项目目录
cd pbstar-admin
# 克隆外部子应用仓库(可选)
git submodule update --init
# 安装pnpm(如果已安装pnpm,请忽略此步骤)
npm install -g pnpm
# 安装依赖
pnpm install
# ts 检查
pnpm run check
# 启动项目
pnpm run dev
# 打包项目
pnpm run build
# 添加指定依赖包
pnpm run add
# 移除指定依赖包
pnpm run remove
# 创建子应用
pnpm run create

📁 项目结构

├── apps                        # 子应用
│ ├── example                   # 示例应用(内部,in)
│ ├── system                    # 系统应用(内部,in)
│ ├── out-app                   # 外部子应用(git submodule,独立仓库,out)
│ ├── appInit.ts                # 子应用公共初始化逻辑
│ ├── useMicroApp.ts            # 微应用挂载公共逻辑
│ └── apps.json                 # 子应用构建/CLI 清单(appKey/appType/devPort/proUrl)
├── assets                      # 共享模块(stores/utils/directives/constants/css/iconfont)
├── components                  # 共享组件库(@Pcomponents)
├── main                        # 主应用(wujie 容器)
├── develop                     # 开发模块(CLI + 接口 mock)
│ ├── cli                       # CLI:create/dev/build/add/remove/check
│ └── mock                      # 接口 mock(可持久化到 localStorage)
├── .env.example                # 环境变量模板(本地 .env 为 gitignore)
├── .gitignore                  # git忽略文件
├── .gitmodules                 # git子模块配置
├── env.d.ts                    # 全局类型声明
├── package.json                # 依赖
├── tsconfig.base.json          # TypeScript 公共配置
├── pnpm-workspace.yaml         # 工作区配置
├── rsbuild.config.ts           # 打包配置
└── README.md                   # 说明

💝 致谢

本项目能够顺利完成,离不开以下优秀开源项目和工具,在此表示衷心感谢:

🏗️ 核心架构

  • git-submodule - 用于实现外部子应用的独立版本控制
  • wujie - 腾讯开源的微前端框架,提供强大的微前端解决方案
  • rsbuild - 基于 Rspack 的高性能构建工具,提供极速的构建体验
  • pnpm - 快速、节省磁盘空间的包管理器,优化依赖管理
  • vue - 渐进式 JavaScript 框架,构建用户界面的基础

📚 灵感采集

About

Pbstar-admin 是一套全面便捷的后台管理系统解决方案,基于 wujie、rsbuild、pnpm 完成微前端架构,运用 vue3、typescript、pinia、element plus 等主流技术栈。

Topics

Resources

Stars

67 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages