Skip to main content

Framework Overview

Developer Beginner

EZ-Console is a comprehensive full-stack framework designed for rapidly building enterprise management systems. It provides a solid foundation with essential features like authentication, authorization, user management, and audit logging out-of-the-box.

What is EZ-Console?​

EZ-Console is a production-ready framework that combines:

  • Backend: Go + Gin + GORM
  • Frontend: React + TypeScript + Ant Design
  • Architecture: Clean layered architecture with dependency injection
  • Security: JWT authentication, RBAC, MFA support
  • Observability: Built-in logging, tracing, and metrics

Why Choose EZ-Console?​

🚀 Rapid Development​

Get a full-featured admin system running in minutes rather than weeks. Focus on your business logic while the framework handles infrastructure concerns.

🏗️ Production Ready​

Battle-tested architecture with security best practices built-in:

  • Secure authentication and authorization
  • Audit logging for compliance
  • Input validation and error handling
  • Performance optimization

🔧 Highly Extensible​

Plugin-based architecture allows you to:

  • Add custom controllers and services
  • Extend built-in modules
  • Integrate with external systems
  • Create reusable components

🌐 Full Stack Integration​

Backend and frontend are designed to work together seamlessly:

  • Type-safe API contracts
  • Consistent error handling
  • Unified configuration
  • Shared authentication flow

📊 Enterprise Features​

Everything you need for enterprise applications:

  • Role-Based Access Control (RBAC)
  • Multi-Factor Authentication (MFA)
  • OAuth2/OIDC integration
  • LDAP/Active Directory support
  • Comprehensive audit logging
  • Multi-tenancy support

🔐 Security First​

Security is not an afterthought:

  • JWT-based stateless authentication
  • Password policies and encryption
  • Permission-based access control
  • Audit trail for compliance
  • SQL injection prevention
  • XSS protection

Core Features​

Backend Capabilities​

RESTful API Framework​

  • High-performance Gin HTTP framework
  • Automatic request routing
  • Middleware support
  • OpenAPI/Swagger documentation

Database & ORM​

  • GORM ORM with rich features
  • Support for SQLite, MySQL, PostgreSQL
  • Automatic migrations
  • Soft deletes
  • Transaction support

Authentication & Authorization​

  • JWT token-based authentication
  • Session management
  • Role-Based Access Control (RBAC)
  • Permission groups and policies
  • Service accounts for API access
  • OAuth2/OIDC providers (Google, Okta, Azure AD)
  • LDAP/Active Directory integration
  • Multi-Factor Authentication (TOTP, Email)

Built-in Modules​

  • User Management: Complete user lifecycle
  • Authorization: Roles, permissions, policies
  • System Settings: Configurable security policies
  • File Management: Upload/download with access control
  • Audit Logging: Automatic action tracking
  • Statistics: System analytics and metrics

Frontend Capabilities​

Modern Technology Stack​

  • React 18 with hooks and concurrent features
  • TypeScript for type safety
  • Vite for fast development and building
  • Ant Design 5 for professional UI

Pre-built Components​

  • User management interface
  • Role and permission management
  • System settings dashboard
  • Audit log viewer
  • File upload/download
  • Form components with validation

Developer Experience​

  • Hot module replacement
  • Component lazy loading
  • Internationalization (i18n)
  • Responsive design
  • Dark mode support

Technology Stack​

Backend Technologies​

CategoryTechnologyVersion
LanguageGo1.20+
Web FrameworkGinLatest
ORMGORMLatest
AuthenticationJWT-
ConfigurationViperLatest
CLICobraLatest
Logginggo-kit/logLatest
TracingOpenTelemetryLatest

Frontend Technologies​

CategoryTechnologyVersion
LanguageTypeScript5.x
FrameworkReact18.x
Build ToolVite5.x
UI LibraryAnt Design5.x
RoutingReact Router6.x
HTTP ClientAxiosLatest
State ManagementReact Context + React QueryLatest
i18nreact-i18nextLatest

Database Support​

  • SQLite - Default, perfect for development and small deployments
  • MySQL/MariaDB - Production-ready relational database
  • PostgreSQL - Advanced features and scalability
  • ClickHouse - Optional analytics database

Use Cases​

EZ-Console is ideal for:

Internal Tools​

  • Admin panels and dashboards
  • Content management systems
  • Configuration management
  • System monitoring tools

Business Applications​

  • Customer relationship management (CRM)
  • Enterprise resource planning (ERP)
  • Project management systems
  • Inventory management

Platform Administration​

  • Multi-tenant SaaS platforms
  • API management portals
  • User and permission management
  • Service configuration interfaces

Developer Tools​

  • API testing tools
  • Development dashboards
  • CI/CD management interfaces
  • Infrastructure management

What Makes EZ-Console Different?​

1. Full-Stack Integration​

Unlike frameworks that only provide backend or frontend, EZ-Console gives you both, perfectly integrated and ready to use.

2. Enterprise Features by Default​

RBAC, audit logging, and multi-tenancy aren't add-ons—they're built into the core.

3. Convention over Configuration​

Sensible defaults mean you can start coding immediately, but everything is customizable when you need it.

4. Production Ready​

Not a toy framework—EZ-Console is used in real-world production applications.

5. Modern Technology​

Built with the latest versions of Go, React, and supporting libraries, using modern best practices.

Architecture Principles​

EZ-Console follows these key design principles:

Separation of Concerns​

Clear boundaries between layers:

  • Controllers handle HTTP requests
  • Services contain business logic
  • Models define data structures
  • Middleware handles cross-cutting concerns

Dependency Injection​

Loose coupling makes code testable and maintainable:

  • Services are injected into controllers
  • Dependencies are explicit
  • Easy to mock for testing

Interface-Based Design​

Program to interfaces, not implementations:

  • Flexibility to swap implementations
  • Easy to extend and customize
  • Clear contracts between components

Security by Default​

Security is built-in, not bolted-on:

  • Authentication required by default
  • Permission checks on sensitive operations
  • Audit logging automatic
  • Input validation mandatory

Learning Path​

We recommend following this learning path:

  1. Start Here: Read this overview to understand what EZ-Console offers
  2. Architecture: Learn about the architecture and core concepts
  3. Installation: Set up your development environment
  4. Quick Start: Build your first application in 10 minutes
  5. Backend Guide: Deep dive into backend development
  6. Frontend Guide: Learn about frontend development
  7. Admin Console & Operations: Operate the system via Usage & Administration—users, RBAC, settings, audit logs, and reports
  8. Advanced Topics: Explore hooks, extensions, and tuning

Getting Help​

If you need assistance:

  • Documentation: You're reading it! Search for specific topics
  • Examples: Check the /demo directory in the repository
  • GitHub Issues: Report bugs or request features
  • GitHub Discussions: Ask questions and share knowledge
  • API Reference: Auto-generated Swagger documentation

Next Steps​

Ready to get started?

Questions or feedback? Open an issue on GitHub.