Elysia Admin

Bun + ElysiaVue 3 单仓全栈;后端以 配置式路由替代链式调用, 自动注册模块与定时任务,Drizzle + TS,RBAC / 队列等开箱可用。

ElysiaJS · Bun · Vue 3 · Drizzle

GitHub starsGitee star

MIT 开源 · 代码托管 GitHub / Gitee · Node ≥22 · Bun ≥1.2.21 · PostgreSQL ≥16 · Redis ≥6

框架能力

对应文档《介绍》中的定位:单仓 admin · server · docs, 典型路径是浏览器访问管理端,经 HTTP 调用 API,由 server 访问 PostgreSQL 与 Redis。

Art Design Pro 管理端

前端基于 Art Design Pro,响应式界面与高级组件开箱即用。

接口与任务自动注册

后端模块与定时任务自动扫描加载,减少手动 import 与配置。

Drizzle + 端到端 TS

从数据库到 API 的类型推导,减少 any,与 DrizzleORM 深度集成。

配置式路由

类似 Vue Router 的声明式路由,路径、方法、权限与处理器解耦。

Bun + Elysia 运行时

server 侧 Bun 运行 ElysiaJS,追求启动速度与请求延迟表现。

RBAC · JWT · 动态路由

内置权限、认证与后台菜单路由能力,贴合常见企业后台需求。

PostgreSQL · Redis

持久化与会话、缓存、队列共用 Redis,与官方文档环境依赖一致。

队列 · 缓存 · 定时任务

异步任务、缓存抽象与 Cron 指南齐全,可与多实例部署配合。

OpenAPI · 存储 · 支付

内置 OpenAPI 文档与 JSON;另有存储、支付等集成指南可按需启用。

架构图

几分钟跑起来

与《快速开始》一致:先克隆单仓(含 admin/ 、server、docs),再在仓库根目录用 Bun 启动 API,在 admin/ 用 pnpm 启动管理端;下方卡片先给克隆地址,再分左右命令。

elysia-admin
单仓克隆(二选一)
# GitHub
git clone 
https://github.com/meishanlaoyao/elysia-admin.git
# Gitee(国内镜像)
git clone 
https://gitee.com/nian-qian/elysia-admin.git

克隆后得到含 admin、server、docs 的完整仓库;下方左侧在仓库根目录启动 API,右侧在 admin/ 下启动前端。

后端(server · Bun)
# 进入后端目录
cd server
# 安装依赖
bun install
# 启动 后端 与 Worker
bun dev:all
# 默认 http://localhost:3000/api

启动成功后控制台会输出本地 API、OpenAPI 与 JSON 地址,详见 快速开始

前端(admin · pnpm)
# 进入前端目录
cd admin
# 安装依赖
pnpm install
# 启动后台管理端
pnpm dev
# 默认 http://localhost:3006

目录与命令与《快速开始》一致;生产环境变量等仍以 文档 为准。

性能与部署画像

文档强调「轻量、可横向扩展」:多实例时通过 Redis 同步会话与状态,队列 Worker 与 HTTP 服务协作方式见 队列指南

典型内存

~80MB

《介绍》中「资源受限环境」场景下的参考占用,随业务与实例数变化。

运行时

Bun + Elysia

server 使用 Bun 启动 Elysia;开发时另起 admin 侧 Vite 开发服务器。

类型与数据

TS + Drizzle

从数据库到 API 的类型推导;PostgreSQL 持久化、Redis 会话与缓存。

监控或压测曲线图

技术栈与依赖

与文档《介绍》中单仓目录、运行时与数据层描述一致;可选工具链(Docker、PM2、RustFS 等)详见该页「环境依赖」小节。

Vue 3 + ViteVue 3 + Vite
Vue 3 + Viteadmin 管理端
Pinia + Vue Router
Pinia + Vue Router状态与路由
Element Plus
Element PlusUI 与 Tailwind 辅助
Elysia on BunElysia on Bun
Elysia on Bunserver API
Drizzle ORM
Drizzle ORM类型安全 SQL
PostgreSQL
PostgreSQL≥ 16
Redis
Redis≥ 6 · 会话/缓存/队列
Docker / PM2Docker / PM2
Docker / PM2可选部署方式

Powered by

  • Vue
  • Vite
  • Pinia
  • Element Plus
  • Elysia
  • Bun
  • Drizzle ORM
  • PostgreSQL
  • Redis
  • Docker
  • PM2

AI 开发指南

与站内文档 《AI 开发指南》 一致:用项目自带规范约束 AI 生成代码,而不是泛泛的「AI 原生」口号。

  • .ai/ 与 IDE 规则

    仓库内 `.ai/` 规范与 Cursor / Trae / Kiro 规则对齐,生成行为与 `AI_CODE_EXAMPLES.md` 一致。

  • 代码模板唯一详版

    长模板以 `.ai/AI_CODE_EXAMPLES.md` 为准;运维与 MCP 等短约定见 `AI_CONTEXT_CAPSULE.md` 按需阅读。

  • 前后端生成边界

    规则文件按路径触发:`general` 管架构与读文件纪律,`backend` / `frontend` 分管 server 与 admin。

  • 提示词与协作

    在对应 IDE 中开箱加载规则,减少「与仓库风格不一致」的重复劳动。

打开完整 AI 开发指南
IDE 规则或 .ai 目录结构示意图(Cursor / 规则文件树)

文档结构

侧栏与路由与当前 VitePress 站点一致(见站内目录与 llms.txt 索引);以下为高频入口链接预览。

正文预览

OpenAPI 与本地联调

后端启动后,控制台会打印 API 根路径、OpenAPI 与 JSON 导出地址(与《快速开始》示例输出一致),便于前端与第三方工具拉取契约。

GET /api/auth/login · 第一个接口 · 项目结构
真实文档页截图:侧栏 + 正文 + 代码块 + 大纲