✨ Features

• 🏗️ Clean Architecture — Domain‑driven layered design (Controller → Usecase → Repository)
• 🔐 RBAC with Casbin — Fine‑grained role‑based access control for APIs and menus
• 🌗 Light & Dark Themes — Seamless theme switching with system preference detection
• 📱 Responsive Design — Optimized for desktop, tablet, and mobile
• 🔍 Global Search — Quick navigation across menus and resources
• 📊 Dashboard — Data visualization with charts and statistics
• 🗂️ Dynamic Menus — Backend‑driven menu tree with permission‑aware rendering
• ⚡ Cacher — Supports Redis or go-cache, flexible and optional
• 🗄️ Multi‑Database — SQLite (default), PostgreSQL, MySQL out of the box

🚀 Get Running

Prerequisites

• Go 1.27.1+
• Node.js 22+ & pnpm 11+

Run

# Clone the repository
git clone https://github.com/ahaodev/shadmin.git
cd shadmin

go install github.com/swaggo/swag/cmd/swag@latest
go install entgo.io/ent/cmd/ent@latest

# Install & build frontend
cd frontend && pnpm install && pnpm build

# Start backend (from project root)
# Generates Ent code, embeds frontend/dist/, listens on :55667
# .env auto‑generated on first run
cd ..
swag init
go run -mod=mod entgo.io/ent/cmd/ent generate ./ent/schema
go run .

Default login: admin / 123

🔐 Auth & Permissions

• Authentication: JWT access + refresh tokens via Authorization: Bearer <token>
• API Authorization: Casbin middleware checks (userID, path, method) on protected routes
• Frontend Guards: Permission‑aware UI via the usePermission() hook and auth-store checks (hasPermission() / hasRole())
• Menu System: Dynamic menus from /api/v1/resources, auto‑adapted to user permissions

shadmin/
├── api/            # Controllers & routes (Gin)
├── bootstrap/      # App bootstrap, DB, Casbin, seed
├── domain/         # Entities, DTOs, interfaces
├── ent/schema/     # Ent ORM schemas
├── repository/     # Data access layer
├── usecase/        # Business logic
├── internal/       # Internal utilities
├── pkg/            # Shared packages
├── frontend/            # React frontend (Vite + shadcn/ui)
│   └── src/
│       ├── routes/       # TanStack file‑based routing
│       ├── features/     # Feature modules
│       ├── services/     # API wrappers (Axios)
│       └── stores/       # Zustand state management
├── docs/           # Documentation & images
└── main.go         # Entry point

📚 Documentation

• Architecture (EN) · 架构 (中文)
• Quick Start (EN) · 快速开始 (中文)
• Development (EN) · 开发指南 (中文)
• Deployment (EN) · 部署 (中文)
• CLI for AI agents · 面向 AI Agent 的 CLI(中文)

📄 License

MIT