Introduction
LaraDashboard Documentation
Welcome to the official documentation for LaraDashboard - a powerful, modular admin panel and Agentic CMS built on Laravel 12.
About LaraDashboard
LaraDashboard is an enterprise-grade admin panel and content management system featuring:
- 🚀 Built on Laravel 12 - Latest Laravel with Livewire 3 & Alpine.js
- 🤖 AI-Powered (Agentic CMS) - Content generation with OpenAI & Claude
- 🧩 Modular Architecture - Extend via installable modules
- 🎨 Visual Page Builder - Drag-and-drop content with LaraBuilder
- 🔐 Enterprise Security - Role-based access control with Spatie
- 🌍 Multi-Language - 21+ languages out of the box
📚 Documentation Index
Getting Started
Everything you need to install and start using LaraDashboard.
| Document | Description |
|---|---|
| Introduction | What is LaraDashboard and why use it |
| Installation | Step-by-step installation guide |
| Configuration | Environment and settings configuration |
| Quick Start | Get up and running in minutes |
Core Concepts
Understand how LaraDashboard is built and organized.
| Document | Description |
|---|---|
| Architecture Overview | System design and patterns |
| Directory Structure | Project folder organization |
| Module System | How modules work |
User Guide
Guides for content managers and administrators.
| Document | Description |
|---|---|
| Dashboard Overview | Navigating the admin panel |
| User Management | Managing users, roles & permissions |
| Content Management | Creating posts, pages & content |
| Media Library | Uploading and managing files |
| Settings | System configuration options |
| Email Templates | Creating and managing email templates |
Developer Guide
Technical documentation for developers building with LaraDashboard.
| Document | Description |
|---|---|
| Module Development | Building custom modules |
| CRUD Generator | Rapid CRUD scaffolding with module:make-crud |
| Admin Menu System | Adding sidebar menus from modules |
| Settings System | Adding settings tabs and sections |
| Settings API | Settings CRUD operations |
| Hooks Reference | Action & filter hooks |
| Inbound Email System | IMAP email processing & handlers |
| Styling Guide | CSS classes, Tailwind, module assets |
| API Development | Building REST APIs |
| Testing Guide | Writing tests with Pest |
Components
Comprehensive Blade component library for building consistent user interfaces.
| Document | Description |
|---|---|
| Components Overview | Introduction to all components |
| Alerts | Success, error, warning, info alerts |
| Buttons | Button variants, icons, loading states |
| Inputs | Form inputs, selects, checkboxes, etc. |
| Cards | Content containers and layouts |
| Modals | Dialogs, drawers, confirmations |
| Datatable | Data tables with sorting and filtering |
| Navigation | Breadcrumbs, tabs, dropdowns |
| Feedback | Tooltips, popovers, toast notifications |
Advanced Topics
In-depth guides for specific features and integrations.
| Document | Description |
|---|---|
| AI Integration | OpenAI & Claude configuration |
| LaraBuilder | Visual page builder guide |
| Datatable System | Enterprise datatable documentation |
| Hooks System | Complete hooks reference |
| Email Providers | Email provider configuration |
| Notification Types | Notification system reference |
| Agentic CMS | AI command center documentation |
| UI Guidelines | Design system and components |
API Reference
Complete REST API documentation.
| Document | Description |
|---|---|
| Authentication | API authentication with Sanctum |
| Endpoints Reference | All available API endpoints |
Deployment & Operations
Guides for deploying and maintaining LaraDashboard.
| Document | Description |
|---|---|
| Deployment Guide | Production deployment |
| Backup & Restore | Data backup strategies |
| Troubleshooting | Common issues and solutions |
🗂️ Documentation Structure
docs/LaraDocs/
├── README.md # This file - Documentation index
│
├── getting-started/ # Getting Started
│ ├── introduction.md
│ ├── installation.md
│ ├── configuration.md
│ └── quickstart.md
│
├── core-concepts/ # Core Concepts
│ ├── architecture.md
│ ├── directory-structure.md
│ └── module-system.md
│
├── user-guide/ # User Guide
│ ├── dashboard.md
│ ├── user-management.md
│ ├── content-management.md
│ ├── media-library.md
│ ├── settings.md
│ └── email-templates.md
│
├── developer-guide/ # Developer Guide
│ ├── module-development.md
│ ├── crud-generator.md
│ ├── admin-menu.md
│ ├── settings-system.md
│ ├── settings-api.md
│ ├── hooks-reference.md
│ ├── inbound-email.md
│ ├── styling.md
│ ├── api-development.md
│ └── testing.md
│
├── components/ # UI Components
│ ├── overview.md
│ ├── alerts.md
│ ├── buttons.md
│ ├── inputs.md
│ ├── cards.md
│ ├── modals.md
│ ├── datatable.md
│ ├── navigation.md
│ └── feedback.md
│
├── advanced-topics/ # Advanced Topics
│ ├── ai-integration.md
│ └── lara-builder.md
│
├── api-reference/ # API Reference
│ ├── authentication.md
│ └── endpoints.md
│
├── deployment/ # Deployment
│ ├── deployment-guide.md
│ ├── backup-restore.md
│ └── troubleshooting.md
│
└── [Existing Documentation] # Legacy docs
├── datatable.md
├── hooks.md
├── lara-builder.md
├── module-development.md
├── agentic-cms.md
├── email-providers.md
├── notification-types.md
└── ui-guidelines.md
🎯 Quick Links
For Users
For Developers
- Module Development
- CRUD Generator
- Admin Menu System
- Settings System
- Hooks Reference
- Inbound Email System
- API Documentation
- Architecture Overview
UI Components
For DevOps
📋 SEO Frontmatter Reference
All documentation files support DocForge SEO frontmatter:
---
title: Page Title
description: Meta description for SEO (max 160 chars)
keywords: [keyword1, keyword2, keyword3]
og_image: /images/page-og.png
schema_type: TechArticle # or HowTo, FAQPage
---
Schema Types
| Type | Use Case |
|---|---|
TechArticle |
Technical documentation (default) |
HowTo |
Step-by-step tutorials |
FAQPage |
FAQ-style content |
🤝 Contribution Guidelines
We welcome contributions to improve the documentation!
Submitting Changes
- Current Stable Release - Submit to the corresponding branch (e.g.,
12.x) - Next Release - Submit to the
mainbranch
Documentation Standards
- Use clear, concise language
- Include code examples where applicable
- Add SEO frontmatter to all pages
- Follow the existing structure
- Test all code examples
Style Guide
- Use sentence case for headings
- Use backticks for
code, paths, and commands - Use tables for structured data
- Include "Next Steps" sections
- Add cross-references to related docs
📞 Getting Help
- GitHub Issues: Report bugs or request features
- Documentation: You're reading it!
- Discord Community: Join our community for support
📄 License
LaraDashboard documentation is licensed under MIT License.
Built with ❤️ by the LaraDashboard Team