Skip to content

ColorlibHQ/gentelella

Repository files navigation

Gentelella Admin Template

Modern Bootstrap 5 Admin Dashboard Template with Vite Build System

Gentelella is a powerful, free-to-use Bootstrap 5 admin template that has been completely modernized with Vite, performance optimizations, and the latest web technologies. This template provides a comprehensive foundation for building admin panels, dashboards, and back-end applications.

Gentelella Bootstrap Admin Template

✨ What's New in v2.0.0 (Stable Release)

  • πŸš€ Vite Build System - Lightning-fast development and optimized production builds
  • πŸ“¦ Bootstrap 5.3.7 - Latest Bootstrap with modern design system
  • ⚑ Performance Optimized - 90% smaller initial bundle size with smart code splitting
  • πŸ”§ Modern JavaScript - ES6+ modules with dynamic imports
  • 🎯 TypeScript Ready - Full TypeScript support available
  • πŸ“± Mobile First - Responsive design optimized for all devices
  • 🎨 Morris.js Eliminated - Complete replacement with modern Chart.js
  • πŸ”§ jQuery Easing Fixed - All animation errors resolved

πŸ“Š Performance Improvements

  • Before: 779 KB monolithic JavaScript bundle
  • After: 79 KB initial load + smart chunk loading
  • Result: 90% smaller initial bundle with 40-70% faster page loads

πŸš€ Quick Start

Prerequisites

Installation

# Clone the repository
git clone https://github.com/puikinsh/gentelella.git
cd gentelella

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Development Commands

# Development with hot reload
npm run dev

# Production build with optimizations
npm run build

# Preview production build locally
npm run preview

πŸ—οΈ Project Structure

gentelella/
β”œβ”€β”€ production/           # HTML templates and static assets
β”‚   β”œβ”€β”€ *.html           # 42 pre-built admin pages
β”‚   └── images/          # Image assets
β”œβ”€β”€ src/                 # Source files
β”‚   β”œβ”€β”€ main-core.js     # Core essentials (79 KB)
β”‚   β”œβ”€β”€ main.scss        # Styles entry point
β”‚   β”œβ”€β”€ js/              # Custom JavaScript
β”‚   β”œβ”€β”€ scss/            # Custom SASS files
β”‚   └── modules/         # Feature-specific modules
β”‚       β”œβ”€β”€ charts.js    # Chart functionality (219 KB)
β”‚       β”œβ”€β”€ forms.js     # Form enhancements (200 KB)
β”‚       β”œβ”€β”€ tables.js    # DataTables functionality
β”‚       └── dashboard.js # Dashboard widgets
β”œβ”€β”€ dist/                # Production build output
β”œβ”€β”€ vite.config.js       # Vite configuration
└── package.json         # Dependencies and scripts

🎯 Smart Loading System

The template now uses intelligent code splitting:

  • Core Bundle (79 KB): Essential libraries loaded on every page
  • Chart Module (219 KB): Only loads on pages with charts
  • Form Module (200 KB): Only loads on pages with advanced forms
  • Table Module: Only loads on pages with DataTables
  • Dashboard Module: Only loads dashboard-specific widgets

πŸ“± Responsive Design

Built with mobile-first approach:

  • Phones: Optimized touch interfaces
  • Tablets: Adaptive layouts
  • Desktops: Full-featured experience
  • Large Screens: Enhanced productivity layouts

πŸ› οΈ Customization

Adding New Pages

  1. Create HTML file in production/ directory
  2. Add entry to vite.config.js input configuration
  3. Reference appropriate modules for functionality needed

Custom Styling

// src/scss/custom.scss
.my-custom-component {
  // Your custom styles
}

Adding Features

// Load modules conditionally
if (document.querySelector('.chart-container')) {
  const charts = await loadModule('charts');
}

πŸ“¦ Available Components

Dashboard Features

  • Multiple Dashboard Layouts - 3 different dashboard designs
  • Widgets - Various dashboard widgets and cards
  • Charts - Chart.js, ECharts, Sparklines integration
  • Maps - Interactive world maps with jVectorMap

Form Components

  • Advanced Forms - Multi-step wizards, validation
  • Form Elements - Rich text editors, date pickers
  • File Upload - Drag & drop file upload with progress
  • Input Enhancements - Autocomplete, tags, switches

UI Elements

  • Tables - DataTables with sorting, filtering, pagination
  • Typography - Comprehensive typography system
  • Icons - Font Awesome 6
  • Media Gallery - Image gallery with lightbox
  • Calendar - Full-featured calendar component

Additional Pages

  • E-commerce - Product listings, shopping cart
  • User Management - Profiles, contacts, projects
  • Authentication - Login, registration pages
  • Error Pages - 403, 404, 500 error pages

🎨 Built With

Core Technologies

  • πŸš€ Vite 6.3.5 - Ultra-fast ES module build system with 90% smaller bundle size
  • πŸ“¦ Bootstrap 5.3.7 - Latest Bootstrap with modern design system
  • 🎨 SASS Modules - Modern CSS architecture with custom theme variables
  • jQuery 3.6.1 - DOM manipulation (being phased out)

Charts & Visualization

  • Chart.js 4.5.0 - Modern charting library (Morris.js completely removed)
  • ECharts 5.6.0 - Professional data visualization
  • Sparklines - Mini charts and graphs
  • jVectorMap - Interactive world maps

Form & UI Libraries

  • Select2 - Enhanced select dropdowns
  • Tempus Dominus - Bootstrap 5 date/time picker
  • Ion Range Slider - Range slider component
  • Switchery - iOS-style toggle switches
  • DataTables - Advanced table functionality

Utilities

  • Day.js - Lightweight date library
  • NProgress - Progress bars for page loading
  • Autosize - Auto-resizing textareas
  • Font Awesome 6 - Icon library

πŸ”§ Configuration

Vite Configuration

The template includes optimized Vite configuration with:

  • Smart code splitting for optimal loading
  • Asset optimization with cache-busting
  • Development server with hot reload
  • Production builds with compression

Performance Features

  • Tree Shaking - Removes unused code
  • Code Splitting - Loads only what's needed
  • Caching Strategy - Optimized for browser caching

πŸš€ Deployment

Build for Production

npm run build

Deploy to Various Platforms

  • Netlify: Drag and drop the dist folder
  • Vercel: Connect your GitHub repository
  • GitHub Pages: Use the built-in GitHub Actions
  • Traditional Hosting: Upload dist folder contents

🀝 Contributing

We welcome contributions! To contribute:

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

Development Setup

git clone https://github.com/your-username/gentelella.git
cd gentelella
npm install
npm run dev

πŸ“š Documentation & Demo

πŸ’Ό Showcase Your Work

We would love to see how you use this awesome admin template. You can notify us about your site, app or service by tweeting to @colorlib. Once the list grows long enough we will write a post similar to this showcase to feature the best examples.

πŸ“¦ Installation via Package Managers

# npm
npm install gentelella --save

# yarn  
yarn add gentelella

# bower (legacy)
bower install gentelella --save

🌍 Community Integrations

Gentelella has been integrated into various frameworks:

Let us know if you have done integration for this admin template on other platforms and frameworks and we'll be happy to share your work.

🎨 Other Templates and Resources by Colorlib

πŸ“„ License

Gentelella is licensed under The MIT License (MIT). You can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software.

Attribution Required: Colorlib must be credited as the original author.

πŸ‘₯ Maintainers

πŸ™ Acknowledgments

  • Bootstrap team for the amazing CSS framework
  • All contributors who have helped improve this template
  • The open-source community for the excellent libraries

Made with ❀️ by Colorlib