Go to file
Aigars Silkalns ccde4134cb Fixed index2.html 2025-06-13 17:25:43 +03:00
.github/workflows Create jekyll-gh-pages.yml 2025-06-12 10:21:59 +03:00
docs Navigation and index.html changes 2025-06-13 13:54:36 +03:00
production Fixed index2.html 2025-06-13 17:25:43 +03:00
src Code cleanup, fixed Dashboard pages 2025-06-13 17:13:12 +03:00
.gitignore Moved to VIte 6 for build process 2025-06-11 14:11:41 +03:00
COMPONENTIZATION_GAMEPLAN.md Proper Vite setup 2025-06-12 09:06:36 +03:00
LICENSE.txt Code cleanup, fixed Dashboard pages 2025-06-13 17:13:12 +03:00
README.md Navigation and index.html changes 2025-06-13 13:54:36 +03:00
README_CN.md remove old Chinese docs and add new Chinese README 2019-05-07 01:59:34 +08:00
changelog.md Update changelog.md 2019-10-24 13:46:39 +03:00
package-lock.json Dependency cleanup 2025-06-13 15:22:45 +03:00
package.json Dependency cleanup 2025-06-13 15:22:45 +03:00
progress.md Proper Vite setup 2025-06-12 09:06:36 +03:00
test_functionality.html Work in progress 2025-06-11 09:57:51 +03:00
test_page.html Code cleanup, fixed Dashboard pages 2025-06-13 17:13:12 +03:00
vite.config.js Navigation and index.html changes 2025-06-13 13:54:36 +03:00

README.md

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

  • 🚀 Vite Build System - Lightning-fast development and optimized production builds
  • đŸ“Ļ Bootstrap 5 - 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

📊 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, Morris.js, 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 + Glyphicons
  • 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

  • Bootstrap 5.3.6 - Modern CSS framework
  • Vite 6.3.5 - Next generation build tool
  • SASS - CSS preprocessor
  • jQuery 3.6.1 - DOM manipulation (being phased out)

Charts & Visualization

  • Chart.js 4.4.2 - Modern charting library
  • Sparklines - Mini charts and graphs
  • jVectorMap - Interactive world maps
  • Gauge.js - Beautiful gauge charts

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