Skip to main content

Welcome to EZ-Console Documentation

Go VersionReact VersionLicense

EZ-Console is a full-stack framework (Go + React) for enterprise admin systemsβ€”auth, RBAC, audit, and more included. For positioning, feature lists, and learning path, read the Framework overview.

πŸ“˜ Getting Started

New to EZ-Console? Start here to learn the basics and build your first application.

Get Started β†’

⚑ Quick Start

Build your first EZ-Console application in 10 minutes.

Quick Start β†’

πŸ’» Backend Development

Learn how to build RESTful APIs with Go and Gin framework.

Learn More β†’

🎨 Frontend Development

Create beautiful admin interfaces with React and Ant Design.

Learn More β†’

πŸ“– Usage and Administration

Use the built-in admin console: users, roles, system settings, audit logs, and reports.

Admin Guide β†’

βš™οΈ Configuration

Database, security, email, OAuth/LDAP, and observability settings.

Configure β†’

✨ Key Features​

Backend (Go + Gin)​

  • RESTful API Framework - Built on high-performance Gin framework
  • Database ORM - GORM with support for SQLite, MySQL, PostgreSQL
  • Authentication & Authorization - JWT, RBAC, MFA, OAuth2/OIDC, LDAP
  • Audit Logging - Automatic tracking of all user actions
  • File Management - Upload/download with storage abstraction
  • Middleware - Built-in authentication, CORS, logging, rate limiting
  • AI Chat - Pluggable models, toolsets (MCP, utils, custom), skills, SSE streaming, optional client tools
  • Background Tasks - Worker pool, scheduled jobs, task logs, artifacts

Frontend (React + TypeScript)​

  • Modern Stack - React 18 + TypeScript + Vite
  • UI Library - Ant Design 5 with professional components
  • State Management - React Context + React Query (TanStack Query)
  • Internationalization - i18next with multiple language support
  • Pre-built Components - User management, roles, permissions, audit logs

🎯 Who Should Use EZ-Console?​

  • Backend Developers building enterprise management systems
  • Full-Stack Developers needing a rapid development framework
  • Platform Engineers creating internal tools and admin panels
  • Startups requiring a production-ready foundation quickly

πŸ“– Documentation Structure​

  • Getting Started - Installation, quick start, core concepts
  • Backend Development - Controllers, services, database, authentication
  • Frontend Development - Components, routing, state management, forms
  • Configuration - Database, security, OAuth, LDAP, monitoring
  • Deployment - Production builds, Docker, Kubernetes, scaling
  • Advanced Topics - Hooks, AI models, AI agent skills, multi-tenancy, WebSocket, performance, extensions
  • Usage & Administration - Admin console, users, roles, settings, audit logs, statistics, tasks
  • Reference - API docs, configuration reference, error codes, CLI

🀝 Community & Support​

πŸ“„ License​

EZ-Console is open-source software licensed under the Apache License 2.0.


Ready to get started? Continue to Overview or jump straight to Quick Start.