README.en.md

HaloLight Docs

简体中文 | English

HaloLight multi-framework admin dashboard documentation site, built with VitePress, supporting bilingual (Chinese & English).

Project Relations

• halolight/docs: The single source of truth for documentation and specifications, defining cross-framework design, interfaces, and best practices
• halolight/halolight: Next.js 14 reference implementation, validating the React path
• halolight/halolight-vue: Vue 3.5 reference implementation, validating the Vue path

Specification updates land here first, then sync to corresponding implementation repos to ensure documentation and code consistency.

Project Overview

HaloLight is an enterprise-grade admin dashboard solution with multi-framework implementations. Reference implementations:

• Next.js 14 ✅ · Preview · GitHub
• Vue 3.5 ✅ · Preview · GitHub

All 14 frontend frameworks, 7 backend APIs, and 8 deployment solutions have been implemented and deployed. See each repo's README for preview URLs.

Frontend Frameworks

Framework	Status	Preview	Repo	Docs
🟦 Next.js 14	✅ Deployed	Preview	GitHub	Guide
⚛️ React (Vite)	✅ Deployed	Preview	GitHub	Guide
💚 Vue 3.5	✅ Deployed	Preview	GitHub	Guide
🔺 Angular 21	✅ Deployed	Preview	GitHub	Guide
🌿 Nuxt 4	✅ Deployed	Preview	GitHub	Guide
🧡 SvelteKit 2	✅ Deployed	Preview	GitHub	Guide
🪐 Astro 5	✅ Deployed	Preview	GitHub	Guide
💠 Solid.js	✅ Deployed	Preview	GitHub	Guide
⚡ Qwik	✅ Deployed	Preview	GitHub	Guide
🎸 Remix	✅ Deployed	Preview	GitHub	Guide
🪶 Preact	✅ Deployed	Preview	GitHub	Guide
🔥 Lit	✅ Deployed	Preview	GitHub	Guide
🦖 Fresh (Deno)	✅ Deployed	Preview	GitHub	Guide
🦕 Deno	✅ Deployed	Preview	GitHub	Guide

Backend APIs

Backend Tech	Status	Preview	Repo	Docs
🦜 NestJS 11	✅ Deployed	API Docs	GitHub	Guide
🐍 Python FastAPI	✅ Deployed	API Docs	GitHub	Guide
☕ Java Spring Boot	✅ Deployed	API Docs	GitHub	Guide
🐹 Go Fiber	✅ Deployed	API Docs	GitHub	Guide
🟩 Node.js Express	✅ Deployed	-	GitHub	Guide
🐘 PHP Laravel	✅ Deployed	-	GitHub	Guide
🍞 Bun + Hono	✅ Deployed	-	GitHub	Guide

Middleware / Full-stack

Project	Status	Description	Repo	Docs
🔗 tRPC BFF	✅ Deployed	Type-safe API Gateway	GitHub	Guide
⚡ Next.js Action	✅ Deployed	Server Actions full-stack	GitHub	Guide

Deployment Options

Platform	Status	Preview	Repo	Docs
Cloudflare	Deployed	Preview	GitHub	Guide
Vercel	Deployed	Preview	GitHub	Guide
Netlify	Deployed	Preview	GitHub	Guide
Docker	Deployed	-	GitHub	Guide
Railway	Deployed	Preview	GitHub	Guide
Fly.io	Deployed	Preview	GitHub	Guide
Azure	✅ Deployed	Preview	GitHub	Guide
AWS	✅ Deployed	Preview	GitHub	Guide

Extension Projects

Project	Status	Description	Repo	Docs
🎨 UI Components	✅ Deployed	Stencil Web Components	GitHub	Guide
🤖 AI Assistant	🚧 In Development	RAG + Action Execution	GitHub	Guide
₿ Web3 Integration	🚧 In Development	Wallet Login + On-chain Data	GitHub	Guide

Core Features

• Draggable Dashboard - Customizable layout Dashboard system
• Permission Control - RBAC permission management with wildcard support
• Theme System - 11 skin presets + light/dark mode
• Mock Data - Complete data simulation for development
• Component Library - 30+ components based on shadcn/ui

Development

# Install dependencies
pnpm install

# Start development server
pnpm dev

# Build for production
pnpm build

# Preview build
pnpm preview

Documentation Structure

docs/
├── .vitepress/              # VitePress configuration
│   ├── config.ts           # Main config
│   ├── nav.ts              # Navigation config
│   ├── sidebar.ts          # Sidebar config
│   ├── head.ts             # HTML head config
│   └── pwa.ts              # PWA config
├── guide/                   # User guides (Chinese)
├── en/guide/                # User guides (English)
├── development/             # Development docs (Chinese)
├── en/development/          # Development docs (English)
├── public/                  # Static assets
├── index.md                 # Homepage (Chinese)
└── en/index.md              # Homepage (English)

Tech Stack

• VitePress - Static Site Generator
• Vue 3 - Progressive JavaScript Framework
• TypeScript - Type Safety
• Pagefind - Full-text Search
• Giscus - Comment System
• PWA - Progressive Web App

Contributing

Contributions are welcome! Feel free to submit Issues and Pull Requests.

1. Fork this repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Create a Pull Request

License

MIT © 2025 h7ml & HaloLight