Adminator-admin-dashboard/docs/index.md

title	description
Adminator Documentation	Complete guide for the Adminator Bootstrap 5 Admin Dashboard Template

Adminator Documentation

Welcome to the comprehensive documentation for Adminator, a modern Bootstrap 5 admin dashboard template with dark mode support.

🌟 Overview

Adminator is a responsive, feature-rich admin template built with:

• Bootstrap 5.3.6 - Latest CSS framework
• Dark Mode System - Complete theme switching with OS detection
• Modern Components - Charts, calendars, maps, and interactive elements
• Performance Optimized - Webpack build system with modern tooling

🚀 Quick Start

# Clone the repository
git clone https://github.com/puikinsh/Adminator-admin-dashboard.git

# Install dependencies
npm install

# Start development server
npm start

Visit http://localhost:4000 to see Adminator in action.

📖 Documentation Sections

🏁 Getting Started

• Installation Guide
• Project Structure
• Development Workflow
• Build & Deployment

🎨 Components

• Charts & Data Visualization
• Forms & Input Elements
• Tables & Data Display
• Navigation & Layout
• Modals & Overlays

🌙 Dark Mode & Theming

• Theme System Overview
• CSS Variables Reference
• Custom Theme Creation
• Component Theming

🔧 API Reference

• Theme API
• Component APIs
• Utility Functions
• Event System

💡 Examples

• Basic Setup
• Custom Components
• Theme Integration
• Advanced Patterns

🚀 Deployment

• Production Build
• Static Hosting
• CDN Integration
• Performance Optimization

🤝 Contributing

• Development Setup
• Code Standards
• Pull Request Process
• Issue Templates

✨ Key Features

🌗 Dark Mode System

• Smart Toggle: Bootstrap-based switch with visual indicators
• OS Detection: Automatically respects user's system preference
• Persistent Storage: Remembers theme choice across sessions
• Component Integration: All elements are theme-aware

📊 Rich Components

• Chart.js Integration: Line, bar, pie, and radar charts
• FullCalendar: Interactive calendar with event management
• DataTables: Advanced table features with search and pagination
• Vector Maps: Interactive world and regional maps
• Google Maps: Custom styled maps with markers

🛠️ Developer Experience

• Modern Tooling: Webpack 5, ESLint 9.x, Sass, PostCSS
• Hot Reload: Instant development feedback
• Code Quality: Automated linting and formatting
• Performance: Optimized builds with code splitting

🔗 Quick Links

• Live Demo - See Adminator in action
• GitHub Repository - Source code and issues
• Changelog - Version history
• License - MIT License

🆕 What's New in v2.6.0

The latest release introduces a comprehensive dark mode system:

• 🌙 Complete Dark Theme with automatic OS detection
• 🎨 Theme-Aware Components for charts, calendars, and maps
• ⚡ Instant Switching without page reload
• 🎯 CSS Variables Architecture for consistent theming
• 📱 Responsive Design across all screen sizes

View Full Changelog →

💬 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: You're here! 📖

---

Happy coding with Adminator! 🚀