Skip to content
Back to search

laradashboard

⚡ Lara Dashboard - CMS by Laravel - All In One solution to start your Laravel Application from Basic to Enterprise. Manages Users, Roles, Permissions, Modules, Settings, Translations, Contents, Monitoring and every actions of your Laravel application. Complete solution for Laravel application with Tailwind, Livewire, Rest API, Unit-Tests and more.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/laradashboard/laradashboard with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/laradashboard/laradashboard'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/laradashboard--laradashboard/badge.svg)](/listings/laradashboard--laradashboard)

HTML

<a href="/listings/laradashboard--laradashboard"><img src="/api/listings/laradashboard--laradashboard/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

**Clone and Go Project**

git clone git@github.com:laradashboard/laradashboard.git
cd laradashboard

**Database & env creation**

- Create database called - `laradashboard` - Create `.env` file by copying `.env.example` file

cp .env.example .env

**Install Composer & Node Dependencies**

composer install
npm install

**Generate Artisan key**

php artisan key:generate

**Link storage for file upload processing**

php artisan storage:link

**Migrate Database with seeder**

php artisan migrate:fresh --seed

**Run Project**

composer run dev

So, You've got the project of Lara Dashboard on your local machine - http://localhost:8000

[Note]: For hot reloading to work, you must need node js version >= 20.19

<p align="right">(<a href="#readme-top">back to top</a>)</p>

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 1,089 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <a id="readme-top"></a>
  2. <div align="center">
  3. <img width="100%" alt="Lara Dashboard — open-source Laravel 13 admin panel, CMS and modular starter kit — dashboard preview with charts, user activity and modules" src="demo-screenshots/03-Dashboard-Page-lite-Mode.png" />
  4. # ⚡ Lara Dashboard
  5. ### Open-source Laravel Admin Panel, CMS & Modular Starter Kit — powered by Laravel 13, Livewire 3, Tailwind CSS v4, built-in MCP for AI agents, and inline AI content tools.
  6. [![Latest Release][release-shield]][release-url]
  7. [![PHP Version][php-shield]][php-url]
  8. [![Laravel][laravel-shield]][laravel-url]
  9. [![Tailwind CSS][tailwind-shield]][tailwind-url]
  10. [![Livewire][livewire-shield]][livewire-url]
  11. [![License][license-shield]][license-url]
  12. [![Stargazers][stars-shield]][stars-url]
  13. [![Forks][forks-shield]][forks-url]
  14. [![Contributors][contributors-shield]][contributors-url]
  15. [![Issues][issues-shield]][issues-url]
  16. **[🌐 Website](https://laradashboard.com) • [🚀 Live Demo](https://laradashboard.com/try-demo/) • [📖 Documentation](https://laradashboard.com/docs/) • [🧩 Marketplace](https://laradashboard.com) • [💬 Community](https://www.facebook.com/groups/laradashboard)**
  17. </div>
  18. ---
  19. **Lara Dashboard** is a **production-ready Laravel admin panel and headless CMS** — a batteries-included **Laravel boilerplate / starter kit** with Users, Roles, Permissions (RBAC via Spatie), Modules, Settings, Translations, Posts & Pages, Media Library, **REST API**, **MCP server for AI agents** (Cursor, Claude Desktop, Claude Code), AI content generation, and a **WordPress-style hooks system** (via [eventy](https://github.com/tormjens/eventy)) for extensibility.
  20. Built for Laravel developers who want to ship admin dashboards, SaaS apps, CRMs and internal tools in **hours, not weeks** — without trading away Laravel idioms, testability or type-safety.
  21. > **Try the live demo:** <https://laradashboard.com/try-demo/>
  22. > **Credentials:** `superadmin@example.com` / `12345678`
  23. ## ✨ Why Lara Dashboard?
  24. - 🔐 **Complete RBAC** — Users, Roles, Permissions via Spatie, admin impersonation, social auth (Socialite), and 2FA-ready flows.
  25. - 🧩 **Modular Architecture** — Self-contained modules via [nwidart/laravel-modules](https://laravelmodules.com/). Install, enable, disable, zip and distribute with a single command.
  26. - ⚡ **CRUD Generator** — `php artisan module:make-crud` scaffolds Model, Migration, Service, FormRequest, Controller, Datatable, Views, Routes, Menu and Tests in one pass.
  27. - 📝 **Full CMS** — Posts, Pages, Categories, Tags, Media Library, visual block-based editor with drag-and-drop.
  28. - 🤖 **Develop & manage with AI (MCP)** — Connect **Cursor**, **Claude Desktop**, or **Claude Code** to your site. Create posts, review CRM leads, send emails, search docs, clear cache, and run daily briefings from natural language — with token-based, permission-scoped access from **Settings → MCP**.
  29. - ✍️ **Inline AI content** — Configure OpenAI, Anthropic, Gemini and more via filter hooks. Generate and refine content inside the admin and builder.
  30. - 📧 **Email System** — Inbound/outbound SMTP connections, visual email template builder, campaign tracking, notifications.
  31. - 🌐 **i18n Out-of-the-box** — 21 languages preloaded, chunked translation management, one-click language adds.
  32. - 🔌 **REST API** — Auto-documented with [Scramble](https://github.com/dedoc/scramble), Sanctum-auth, ready for mobile apps and SPAs.
  33. - 🎨 **Beautiful UI** — Tailwind CSS v4, Alpine.js, dark/light mode, 60+ components, responsive on every breakpoint.
  34. - 🪝 **WordPress-style Hooks** — Actions and filters everywhere so you can extend without forking.
  35. - 🧪 **Tests & Static Analysis** — Pest, PHPStan (Larastan), Rector, Pint — all wired up out of the box.
  36. - 📦 **Zero-friction Deploy** — cPanel/shared-hosting ready, ZIP distribution with vendor folder, one-click core upgrades with backup/restore.
  37. ## 🤖 Develop & Manage Your Site with AI (MCP)
  38. Lara Dashboard ships a **built-in [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server** so AI coding assistants can operate your site like a power user — not just write code about it.
  39. Connect **Cursor** (Desktop or CLI), **Claude Desktop**, or **Claude Code**, generate an MCP agent token in **Settings → MCP**, and ask your assistant to manage day-to-day work: draft and publish posts, triage form submissions, update CRM records, send templated email, inspect logs, and more. Installed modules can expose their own tools through the **`McpFilterHook`** registry.
  40. **What you can do from Cursor, Claude, or similar clients**
  41. | Area | Examples |
  42. | --- | --- |
  43. | **Content** | List, create, and update posts; generate SEO meta |
  44. | **CRM** | Contacts, deals, tickets, and activities *(CRM module)* |
  45. | **Forms** | Review new submissions and mark them viewed *(Forms module)* |
  46. | **Email** | List templates and send mail to users or contacts |
  47. | **Operations** | Daily briefing, clear cache, list storage log files |
  48. | **Docs** | Search and read LaraDashboard guides *(DocForge module)* |
  49. **Quick start**
  50. 1. Open **Settings → MCP**, enable the MCP server, and save.
  51. 2. Click **Generate MCP token** and copy the token (shown once).
  52. 3. Add the server config to your AI client — the admin UI includes ready-made JSON for Cursor, Claude Desktop, and Claude Code.
  53. Example config for **Cursor** (`~/.cursor/mcp.json` or project `.cursor/mcp.json`):
  54. ```json
  55. {
  56. "mcpServers": {
  57. "laradashboard": {
  58. "url": "https://your-site.test/mcp",
  59. "headers": {
  60. "Authorization": "Bearer YOUR_MCP_AGENT_TOKEN"
  61. }
  62. }
  63. }
  64. }
  65. ```
  66. For local development, you can store the token in an env var (`LARADASHBOARD_MCP_TOKEN`) and reference it from the config snippet in **Settings → MCP**.
  67. > **Note:** The MCP endpoint returns 404 until MCP is enabled in settings. Regular API login tokens do not work — use a dedicated MCP agent token with the abilities you choose.
  68. ## 📚 Table of Contents
  69. - [Develop & Manage with AI (MCP)](#-develop--manage-your-site-with-ai-mcp)
  70. - [Requirements](#-requirements)
  71. - [Built With](#️-built-with)
  72. - [Project Setup](#-project-setup)
  73. - [Build Commands](#-build-commands)
  74. - [Features — How it Works](#️-how-it-works)
  75. - [Module Development](#-module-development)
  76. - [CRUD Generator](#crud-generator)
  77. - [REST API](#-rest-api-documentation)
  78. - [Tests & Code Quality](#tests)
  79. - [Distribution Package](#-distribution-package-zip-build)
  80. - [Screenshots](#-screenshots)
  81. - [Premium Modules](#-premium-features)
  82. - [Changelog](#-changelog)
  83. - [Contributing](#-contributing)
  84. ## 📋 Requirements:
  85. - Spatie role permission package `^6.4`
  86. - Pest test package `^4.x`
  87. - Tailwind CSS >= 4.x
  88. - Laravel Modules - https://laravelmodules.com/docs/12/getting-started/introduction
  89. - Laravel Events (A WordPress like action/filter hooks) - https://github.com/tormjens/eventy
  90. - PHP 8.3 or 8.4
  91. - Node.js >= 20.19 - https://nodejs.org/en/download/
  92. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  93. ### 🛠️ Built With
  94. - [![PHP][PHP.com]][PHP-url]
  95. - [![Laravel][Laravel.com]][Laravel-url]
  96. - [![Tailwind CSS][TailwindCSS.com]][TailwindCSS-url]
  97. - [![JavaScript][JavaScript.com]][JavaScript-url]
  98. - [![Alpine JS][AlpineJS.com]][AlpineJS-url]
  99. - [![React][React.js]][React-url]
  100. - [![MySQL][MySQL.com]][MySQL-url]
  101. - <a href="https://penguinui.com/">
  102. <img src="https://res.cloudinary.com/ds8pgw1pf/image/upload/v1721401292/penguinui/main-assets/Logo.png" alt="Penguin UI" style="height: 30px;">
  103. </a>
  104. - <a href="https://tailadmin.com" style="display: flex; align-items: center; text-decoration: none; color: #3d51e0;">
  105. <img src="https://avatars.githubusercontent.com/u/95587422?v=4" alt="Tail Admin" style="height: 20px;"> <span style="color:#3d51e0; margin-left: 5px;">Tail Admin</span>
  106. </a>
  107. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  108. ## 📝 Changelog
  109. > **Latest release:** [v1.5.4](https://github.com/laradashboard/laradashboard/releases/tag/v1.5.4) • [Full changelog →](CHANGELOG.md) • [All GitHub releases](https://github.com/laradashboard/laradashboard/releases)
  110. **[v1.5.4] — 2026-11-17**
  111. - **Feature:** Scheduled posts and pages publish automatically (`posts:publish-scheduled`, every minute; needs the scheduler cron).
  112. - **Feature:** LaraBuilder columns stack on phones, and large headings scale down on small screens; the editor previews match.
  113. - **Fix (Security):** Settings and Theme image uploads only accept real image files, closing remote code execution through an uploaded `.php` logo (GHSA-r9ch-j892-qrh2).
  114. - **Fix (Security):** Media file names and post list titles/categories are escaped, closing XSS through crafted file names.
  115. - **Fix:** Excerpts from LaraBuilder content are no longer empty; email template previews fill variables with sample data and load in an isolated frame.
  116. - **Fix:** Editor role defaults include post and media permissions; post view counts work on MySQL/MariaDB.
  117. - **Fix:** Builder blocks with empty spacing, slash-menu Enter, module upload conflict queue, sticky table header beside side forms, and media thumbnails.
  118. **[v1.5.3] — 2026-11-15**
  119. - **Fix (Security):** Custom menu item links only accept `http`, `https`, `mailto`, `tel`, `sms` or relative URLs, closing a stored XSS in the public navigation (GHSA-883p-xm36-3p99).
  120. - **Fix (Security):** Social login sign-ups count toward the per-IP daily registration limit and pass the spam-name and email checks (GHSA-w29c-wmgq-hfrc).
  121. - **Fix (Security):** The Ollama base URL check blocks cloud metadata addresses written in any IPv6 notation, e.g. `::ffff:a9fe:a9fe` (GHSA-7447-x4w9-pc4p).
  122. - **Fix:** Core upgrades and module installs pick a command-line PHP that matches the site's PHP version; override with `PHP_CLI_BINARY`.
  123. - **Chore:** Laravel 13.40.0.
  124. **[v1.5.2] — 2026-11-08**
  125. - **Fix (Security):** Ollama base URL is validated and Superadmin-only, closing an SSRF via `generate-seo` (GHSA-47pj-m4xp-74g5).
  126. - **Fix (Security):** Secret settings (API keys, passwords, client secrets) are masked in the action log, including existing entries (GHSA-29v7-6x3j-r97q). Rotate secrets saved before this release.
  127. - **Fix (Security):** Dashboard Quick Draft requires `post.create` (GHSA-p4mj-68rh-c24q).
  128. - **Fix:** AI image generation works again after DALL-E 3's retirement; defaults to `gpt-image-2.5-flare`.
  129. - **Fix:** Older datatable `render()` overrides no longer throw `Undefined variable $visibleHeaders`.
  130. - **Fix:** LaraBuilder video block embeds YouTube, Vimeo and Dailymotion players on published pages.
  131. **[v1.5.1] — 2026-11-05**
  132. - **Fix (Security):** Passwords are capped at 72 characters (bcrypt's limit) on registration, reset, profile and user forms; login accepts up to 255 so existing accounts still work.
  133. - **Fix:** Deploy migrations no longer fail when a module loads its own `vendor/autoload.php`; module autoloaders are pre-included after core.
  134. - **Tests:** The core test suite no longer boots installed modules or rewrites `modules_statuses.json`.
  135. **[v1.5.0] — 2026-11-04**
  136. - **New:** OAuth 2.1 for the MCP server, so OAuth-only clients like Claude.ai custom connectors can connect with just the `/mcp` URL (PKCE, rotating refresh tokens).
  137. - **Fix (Security):** Module installs can no longer write outside `modules/` via crafted folder names (GHSA-75q6-qrv2-96rx).
  138. - **Fix:** Module `vendor/` autoloaders no longer override core framework classes.
  139. - **Change:** OpenAI defaults to `gpt-6-luna`; `gpt-6-sol` replaces the retired GPT-4o/GPT-4/GPT-3.5 models.
  140. **[v1.4.9] — 2026-11-02**
  141. - **Fix (Security):** Social login no longer links an existing account to an unverified provider email; the OAuth callback is rate-limited (GHSA-c5x3-wvxj-7cgr).
  142. - **Fix (Security):** LaraBuilder content is sanitized on save and load, closing stored XSS in the builder, admin previews, and rendered pages (GHSA-rf5h-55h2-jmf8, GHSA-9gg9-jh9p-fw37).
  143. - **Fix (Security):** MCP `send-email` requires `email_template.edit` (GHSA-gjfv-h634-pxpv).
  144. - **Chore:** Livewire 4.4.8, Laravel 13.39, CommonMark 2.10.4, svg-sanitize 1.0.0, Vite 7.3.7, and other dependency security updates.
  145. **[v1.4.8] — 2026-10-03**
  146. - **Fix (Security):** Fixed some security improvements.
  147. - **Fix:** Fixed some mobile responsive issues.
  148. **[v1.4.7] — 2026-10-02**
  149. - **Fix (Security):** Settings secrets stay hidden from `settings.view`; registration IP limits, Superadmin role changes, post publish status, email-builder redirects, and MCP base64 uploads are locked down.
  150. - **Fix (Security):** Public translation JSON can only be read from `resources/lang` (GHSA-43jp-66c9-7cgh).
  151. - **Fix:** Datatable horizontal scroll, small-screen toolbar, and sticky header stacking.
  152. - **Chore:** `phpseclib` 3.0.57 and `js-yaml` 5.4.2.
  153. **[v1.4.5] — 2026-09-23**
  154. - **New:** Datatable column visibility on every list, and unified page scroll with sticky headers and pagination.
  155. - **New:** View counts on Posts and Pages admin lists.
  156. - **New:** MCP multipart hero uploads with `serve_ok` checks; base64 uploads capped at ~100KB (#327).
  157. - **New:** Multi-turn AI chat completion across OpenAI, Claude, Gemini, and Ollama.
  158. - **Fix (Security):** Core upgrades and Livewire module enable, disable, delete, and update actions are authorized (Superadmin / `ModulePolicy`).
  159. - **Fix:** Text editor autoresize for embedded media; MCP media serve checks and signed uploads.
  160. **[v1.4.2] — 2026-09-14**
  161. - **New:** Public-form spam protection — honeypot, reCAPTCHA v3, disposable/typo/domain email validation, and reusable Blade components for Livewire forms.
  162. - **New:** MCP `UploadMediaTool` for AI agents to upload files to the media library.
  163. - **Improve:** Datatable shift-click bulk selection and sticky headers.
  164. - **Improve:** Module replace UX (auto-activate + **Replaced & active** badge), MCP settings UI, and auth email guard settings.
  165. - **Fix:** MCP media URLs, bulk actions dropdown, Pulse storage on fresh installs.
  166. **[v1.4.0] — 2026-09-07**
  167. - **New:** MCP server for AI agents — token-based access from **Settings → MCP** with tools for content, CRM, forms, email, docs, cache, and logs.
  168. - **New:** Module MCP registry (`McpFilterHook`) so installed modules can expose tools and briefing providers.
  169. **[v1.3.2] — 2026-09-06**
  170. - **New:** Dashboard widget customization — per-user show/hide for stat cards and sections.
  171. - **Improve:** Lara Builder drag preview, save reliability, and list block UX.
  172. - **Fix:** `ModuleStyles` asset scoping and module installation activation edge cases.
  173. - **Fix (Security):** Superadmin-only marketplace install and manual core upgrade upload; post builder upload authorization; markdown fetch SSRF hardening.
  174. - **Chore:** Dependency updates (`livewire`, `league/commonmark`, `browserslist`, `fast-uri`).
  175. **[v1.3.1] — 2026-08-31**
  176. - **Fix:** Password visibility toggle accessibility — `aria-label`, `aria-pressed`, and hide tooltip (#296).
  177. - **Fix:** Mobile sidebar toggle icon and `aria-label` / `aria-expanded` on small screens (#295).
  178. - **Fix:** Fresh install migration failure when `posts.design_json` is missing; guarded canvas padding migration.
  179. - **Improve:** Core upgrade supports `UPGRADE_ZIP_PATH`; release workflow demo upgrade uses built artifact ZIP.
  180. - **Chore:** Synced new accessibility strings across 31 locales.
  181. **[v1.3.0] — 2026-08-30**
  182. - **Fix:** Hardened media uploads — SVG sanitization, MIME validation, and `.htaccess` hardening on public storage.
  183. - **Fix:** License API authorization and backup path traversal protection.
  184. - **Fix:** Media library upload modal Alpine.js quoting; restored header upload button.
  185. - **New:** GitHub Actions release pipeline — demo deploy, auto-release, marketplace publish, `/api/health`.
  186. - **New:** Headless upgrade commands, Hostinger deploy scripts, and `module:publish-images`.
  187. - **Change:** Demo refresh moved to hourly; module menu logos fixed after deploy.
  188. - **Chore:** Dependency updates (`league/commonmark`, `guzzlehttp/guzzle`, npm packages).
  189. **[v1.2.2] — 2026-07-17**
  190. - **Fix:** Core upgrade hardening — vendor staging/validation, CLI subprocess migrations, and vendor included in pre-upgrade backups (fixes shared-hosting upgrade failures).
  191. - **Fix:** `protect-local-files` Composer script runs via PHP for Windows compatibility.
  192. **[v1.2.1] — 2026-07-15**
  193. - **Fix:** Text Editor block lifecycle and list markers in the canvas; list blocks keep content when changing type.
  194. - **New:** Native Ctrl+Z / Cmd+Z undo in Lara Builder; `ModuleStyles` component for safe module Vite CSS.
  195. - **Fix:** `module:make-crud` command and stubs; bumped `spatie/laravel-medialibrary` to 11.23.0.
  196. **[v1.2.0] — 2026-06-21**
  197. - **New:** Lara Builder SEO drawer with live score, checklist, SERP preview, and AI-generated meta fields.
  198. - **New:** Auto-save for draft posts, text ↔ heading block conversion, and unified content typography tokens (inherit-by-default colors + section text color).
  199. - **Fix:** Media library featured image duplicates, broken thumbnails/URLs, and publish/save “Unsaved” false-positive state.
  200. - **Improve:** Media upload auto-select, post list thumbnails, builder header/actions, and AI content modal UX.
  201. **[v1.1.5] — 2026-05-18**
  202. - **Fix:** Migration is now idempotent — safe to re-run on databases that half-applied the v1.1.4 release.
  203. **[v1.1.4] — 2026-05-18**
  204. - **New:** Daily error digest email notifications for admins with error details.
  205. - **Improve:** Improved module generator command to support custom stub templates and better error handling.
  206. - **Fix:** Fixed switch toggle component styling.
  207. **[v1.1.3] — 2026-05-04**
  208. - **Improve:** Improved file upload component with close button and better error handling.
  209. - **Fix:** Fixed minor upgrade issue for demo mode.
  210. **[v1.1.2] — 2026-04-19**
  211. - **Fix:** Module generator command improvement for Windows OS.
  212. - **Fix:** CRUD generator command improvement for Windows OS.
  213. - **Improve:** Added more extendibility support for email templates.
  214. - **Improve:** Added more extendibility support for authentication pages.
  215. **[v1.1.1] — 2026-04-10**
  216. - **Feat:** Scheduled queue worker — runs every minute via `schedule:run` to process queued jobs (workflow actions, emails) without requiring a long-running worker.
  217. - **Improve:** Sidebar submenu supports deeper (3rd and 4th level) nesting with proper indentation.
  218. - **Improve:** Sidebar submenu expands without an inner scrollbar; the sidebar wrapper handles overflow when nav is long.
  219. - **Fix:** Cleaned up user dropdown styling in the admin header.
  220. 👉 **[See the full changelog for all versions (v0.9.x – v2.x) →](CHANGELOG.md)**
  221. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  222. ## 🚀 Project Setup
  223. **Clone and Go Project**
  224. ```console
  225. git clone git@github.com:laradashboard/laradashboard.git
  226. cd laradashboard
  227. ```
  228. **Database & env creation**
  229. - Create database called - `laradashboard`
  230. - Create `.env` file by copying `.env.example` file
  231. ```bash
  232. cp .env.example .env
  233. ```
  234. **Install Composer & Node Dependencies**
  235. ```console
  236. composer install
  237. npm install
  238. ```
  239. **Generate Artisan key**
  240. ```console
  241. php artisan key:generate
  242. ```
  243. **Link storage for file upload processing**
  244. ```console
  245. php artisan storage:link
  246. ```
  247. **Migrate Database with seeder**
  248. ```console
  249. php artisan migrate:fresh --seed
  250. ```
  251. **Run Project**
  252. ```php
  253. composer run dev
  254. ```
  255. So, You've got the project of Lara Dashboard on your local machine - http://localhost:8000
  256. [Note]: For hot reloading to work, you must need node js version >= 20.19
  257. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  258. ## 🔨 Build Commands
  259. | Command | Description |
  260. |---------|-------------|
  261. | `npm run build` | Build core only |
  262. | `npm run build:all` | Build core + all enabled modules |
  263. | `npm run build:modules` | Build all enabled modules |
  264. | `npm run build:modules -- --modules=crm` | Build specific module |
  265. | `npm run build:modules -- --modules=crm,customform` | Build multiple modules |
  266. | `npm run dev` | Dev server (core + modules) |
  267. | `npm run dev:core` | Dev server (core only) |
  268. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  269. ## 📦 Distribution Package (Zip Build)
  270. Create a production-ready zip package for distribution or manual upgrades. This package includes the vendor folder so users don't need Composer installed.
  271. **Using the Admin Panel:**
  272. 1. For production distribution, first run: `composer install --no-dev --optimize-autoloader`
  273. 2. Go to **Settings → Core Upgrades**
  274. 3. Click **Create Backup**
  275. 4. Select backup type (Core + Modules recommended)
  276. 5. Check **Include vendor folder** for production deployment
  277. 6. Download the generated zip file
  278. 7. Restore dev dependencies: `composer install`
  279. **Manual Zip Creation:**
  280. ```bash
  281. # Build all assets first
  282. npm run build:all
  283. # Install production-only dependencies (removes dev packages like Pest, PHPUnit, etc.)
  284. composer install --no-dev --optimize-autoloader
  285. # Create distribution zip (excludes node_modules, .git, tests, uploads, etc.)
  286. zip -r laradashboard-v$(cat version.json | grep -o '"version": "[^"]*' | cut -d'"' -f4).zip \
  287. app bootstrap config database resources routes vendor Modules \
  288. public/.htaccess public/index.php public/favicon.ico public/robots.txt \
  289. public/asset public/backend public/build public/build-* public/css public/js public/images/logo \
  290. storage/app/.gitignore storage/app/public/.gitignore \
  291. storage/framework/.gitignore storage/framework/cache/.gitignore \
  292. storage/framework/sessions/.gitignore storage/framework/views/.gitignore \
  293. storage/logs/.gitignore \
  294. artisan composer.json composer.lock package.json version.json index.php \
  295. .env.example .htaccess vite.config.js tailwind.config.js postcss.config.js \
  296. -x "*.git*" -x "node_modules/*" -x "tests/*" -x "storage/logs/*" -x "public/images/uploads/*" -x "public/uploads/*"
  297. # Restore dev dependencies for local development
  298. composer install
  299. ```
  300. > **Note:** Running `composer install --no-dev` before creating the zip ensures the vendor folder only contains production dependencies, significantly reducing the package size.
  301. **What's included in the distribution package:**
  302. - `app/` - Application code
  303. - `bootstrap/` - Bootstrap files
  304. - `config/` - Configuration files
  305. - `database/` - Migrations, seeders, factories
  306. - `public/` - Public assets (build, css, js, images)
  307. - `resources/` - Views, JS, CSS, lang files
  308. - `routes/` - Route definitions
  309. - `vendor/` - Composer dependencies (optional, for production)
  310. - `index.php` - Root entry point for shared hosting (cPanel)
  311. - `.htaccess` - Apache rewrite rules
  312. - `.env.example` - Environment template
  313. - Core config files (composer.json, package.json, etc.)
  314. **Shared Hosting (cPanel) Deployment:**
  315. The package includes `index.php` and `.htaccess` in the root directory, so it works out-of-the-box on shared hosting without changing document root:
  316. ```bash
  317. # Upload all files to public_html/
  318. # No need to change document root - just upload and configure .env
  319. ```
  320. If you prefer the standard Laravel setup (recommended for VPS/dedicated servers):
  321. 1. Point your domain's document root to the `public/` directory
  322. 2. Or create a symlink: `ln -s /path/to/laradashboard/public /home/user/public_html`
  323. **Fresh Installation from Zip:**
  324. ```bash
  325. # Extract the zip
  326. unzip laradashboard-vX.X.X.zip -d laradashboard
  327. cd laradashboard
  328. # Configure environment
  329. cp .env.example .env
  330. php artisan key:generate
  331. # Update .env with your database credentials
  332. # DB_DATABASE=your_database
  333. # DB_USERNAME=your_user
  334. # DB_PASSWORD=your_password
  335. # Run migrations
  336. php artisan migrate --seed
  337. php artisan storage:link
  338. # If vendor was not included, run:
  339. composer install --no-dev --optimize-autoloader
  340. ```
  341. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  342. ## 🔄 Previously From laravel-role
  343. We were previously at https://github.com/ManiruzzamanAkash/laravel-role, so you need to change the URL if you moved from there
  344. ```console
  345. git remote set-url origin git@github.com:laradashboard/laradashboard.git
  346. ```
  347. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  348. ## ⚙️ How it works
  349. 1. Login using Super Admin Credential -
  350. 1. Email - `superadmin@example.com`
  351. 1. Password - `12345678`
  352. 1. Forget password - Password forget and reset will work if email is set up properly
  353. 1. Create User
  354. 1. Create Role
  355. 1. Assign Permission to Roles
  356. 1. Assign Multiple Role to an User
  357. 1. Check by login with the new credentials.
  358. 1. If you've not enough permission to do any task, you'll get a warning message.
  359. 1. Dashboard with Beautiful chart integrated
  360. 1. Module Based Development - Custom Module Add/Enable/Disable/Delete with detail view
  361. 1. Monitoring - Logging of every action of your application
  362. 1. Monitoring - Laravel Pulse
  363. 1. Translation Management - Add/Edit/Delete Language, Add/Edit/Delete Translation
  364. 1. Settings - General, Site Appearance, Content, Integration, Security settings
  365. 1. Admin Menu - Add/Edit/Delete Menu, Submenu, Link
  366. 1. Admin Impersonation - Login as another user and switch back to your original account
  367. 1. Custom Error Pages - 404, 500, 503, 403
  368. 1. Content Management System - Add/Edit/Delete Content, Content Category, Content Tag
  369. 1. AI Content Generation - Configure AI providers (OpenAI, Anthropic, etc.) for content generation
  370. 1. MCP Server - Connect Cursor, Claude Desktop, or Claude Code; manage content, CRM, forms, email, cache, and logs from AI agents (**Settings → MCP**)
  371. 1. Email Management - Email connections, email templates with visual builder, notifications
  372. 1. Detail Pages - User, Role, Permission, Module detail views with comprehensive information
  373. 1. REST API — auto-documented REST endpoints for Users, Roles, Permissions, Settings, Translations, and Content (Post / Page / Category / Tag).
  374. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  375. ## 📧 Email setup
  376. You can use Mailpit to test emails easily - https://mailpit.axllent.org/
  377. Installation link - https://mailpit.axllent.org/docs/install/
  378. ```bash
  379. MAIL_MAILER=smtp
  380. MAIL_HOST=127.0.0.1
  381. MAIL_PORT=1025
  382. MAIL_USERNAME=null
  383. MAIL_PASSWORD=null
  384. MAIL_ENCRYPTION=null
  385. MAIL_FROM_ADDRESS=dev@example.com
  386. MAIL_FROM_NAME="${APP_NAME}"
  387. ```
  388. Browse Emails - http://localhost:8025
  389. >[!NOTE] You can also create custom Email connection from Email Connections page.
  390. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  391. ## 📚 Documentation
  392. https://laradashboard.com/docs/
  393. ## 🔗 Rest API Documentation
  394. We've used [Scramble](https://github.com/dedoc/scramble) to automatically generate the Rest API documentation for Lara Dashboard. You can find the API documentation at:
  395. http://localhost:8000/docs/api
  396. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  397. ## Tests
  398. We've used Laravel Pint, Rector, Larastan(PHPstan) - static analysis and Pest for unit tests, e2e (browser) tests.
  399. ```bash
  400. composer run test
  401. ```
  402. ```bash
  403. composer run test
  404. ```
  405. **Format:** To format the code, we've used `pint`. You can run the following command to format the code:
  406. ```bash
  407. composer run format
  408. ```
  409. **Type Safety:** To improve type safety, we've used `rector`. You can run the following command to add type hints:
  410. ```bash
  411. composer run type-check
  412. ```
  413. You can also run individual commands for each tool (optional):
  414. ```bash
  415. composer run pint
  416. composer run phpstan
  417. composer run pest
  418. ```
  419. ## 🛠️ Troubleshooting
  420. <details>
  421. <summary><strong>Laragon/Windows: ext-sockets missing</strong></summary>
  422. If you get this error during `composer install`:
  423. ```
  424. pestphp/pest-plugin-browser requires ext-sockets * -> it is missing from your system
  425. ```
  426. **Fix:** Enable the sockets extension in `php.ini`:
  427. ```ini
  428. extension=sockets
  429. ```
  430. Or via Laragon UI: Right-click tray → **PHP** → **Extensions** → check **sockets**
  431. **Quick workaround:**
  432. ```bash
  433. composer install --ignore-platform-req=ext-sockets
  434. ```
  435. </details>
  436. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  437. ## 🚀 Laravel Boost
  438. Laravel Boost is already installed in this project to provide enhanced development and debugging tools for Lara Dashboard.
  439. **How to use Boost:**
  440. Visit the [Laravel Boost documentation](https://github.com/laravel/boost).
  441. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  442. ## 📸 Screenshots
  443. ### 🔐 Login & Authentication
  444. <table>
  445. <tr>
  446. <td width="50%">
  447. <strong>Login Page</strong><br/>
  448. <img width="100%" alt="Login Page" src="/demo-screenshots/00-Login-Page-Lite-Mode.png"/>
  449. </td>
  450. <td width="50%">
  451. <strong>Forget Password Page (Dark Mode)</strong><br/>
  452. <img width="100%" alt="Forget Password Page" src="/demo-screenshots/01-Forget-password.png"/>
  453. </td>
  454. </tr>
  455. </table>
  456. ### 📊 Dashboard
  457. <table>
  458. <tr>
  459. <td width="50%">
  460. <strong>Dashboard (Light Mode)</strong><br/>
  461. <img width="100%" alt="Dashboard Light Mode" src="/demo-screenshots/03-Dashboard-Page-lite-Mode.png"/>
  462. </td>
  463. <td width="50%">
  464. <strong>Dashboard (Dark Mode)</strong><br/>
  465. <img width="100%" alt="Dashboard Dark Mode" src="/demo-screenshots/04-Dashboard-Page-Dark-Mode.png"/>
  466. </td>
  467. </tr>
  468. <tr>
  469. <td width="50%">
  470. <strong>Dashboard Collapsed Sidebar</strong><br/>
  471. <img width="100%" alt="Dashboard Collapsed Sidebar" src="/demo-screenshots/04_1-Dashboard-Collapsed-Sidebar.png"/>
  472. </td>
  473. </tr>
  474. </table>
  475. ### 🔑 Role Management
  476. <table>
  477. <tr>
  478. <td width="50%">
  479. <strong>Role List (Light Mode)</strong><br/>
  480. <img width="100%" alt="Role List" src="/demo-screenshots/05-Role-List-Lite.png"/>
  481. </td>
  482. <td width="50%">
  483. <strong>Role List (Dark Mode)</strong><br/>
  484. <img width="100%" alt="Role List Dark" src="/demo-screenshots/06-Role-List-Dark.png"/>
  485. </td>
  486. </tr>
  487. <tr>
  488. <td width="50%">
  489. <strong>Role Create</strong><br/>
  490. <img width="100%" alt="Role Create" src="/demo-screenshots/07-Role-Create.png"/>
  491. </td>
  492. <td width="50%">
  493. <strong>Role Edit</strong><br/>
  494. <img width="100%" alt="Role Edit" src="/demo-screenshots/08-Role-Edit.png"/>
  495. </td>
  496. </tr>
  497. <tr>
  498. <td width="50%">
  499. <strong>Role Detail</strong><br/>
  500. <img width="100%" alt="Role Detail" src="/demo-screenshots/08_1-Role-Detail-Lite-Mode.png"/>
  501. </td>
  502. <td width="50%">
  503. <strong>Permission List</strong><br/>
  504. <img width="100%" alt="Permission List" src="/demo-screenshots/09-Permissions-List-Lite-Mode.png"/>
  505. </td>
  506. </tr>
  507. <tr>
  508. <td width="50%">
  509. <strong>Permission Detail</strong><br/>
  510. <img width="100%" alt="Permission Detail" src="/demo-screenshots/09_1-Permission-Detail-Lite-Mode.png"/>
  511. </td>
  512. <td width="50%">
  513. <!-- Reserved for future screenshot -->
  514. </td>
  515. </tr>
  516. </table>
  517. ### 👥 User Management
  518. <table>
  519. <tr>
  520. <td width="50%">
  521. <strong>Users List (Light mode)</strong><br/>
  522. <img width="100%" alt="Users List (Light mode)" src="/demo-screenshots/10-User-List-Lite-Mode.png"/>
  523. </td>
  524. <td width="50%">
  525. <strong>User Create (Dark mode)</strong><br/>
  526. <img width="100%" alt="User Create" src="/demo-screenshots/11-User-Create-Dark-Mode.png"/>
  527. </td>
  528. </tr>
  529. <tr>
  530. <td width="50%">
  531. <strong>User Detail</strong><br/>
  532. <img width="100%" alt="User Detail" src="/demo-screenshots/12_1-User-Detail-Lite-Mode.png"/>
  533. </td>
  534. <td width="50%">
  535. <strong>Profile Edit</strong><br/>
  536. <img width="100%" alt="Profile Edit" src="/demo-screenshots/12-Profile-Edit-Lite-Mode.png"/>
  537. </td>
  538. </tr>
  539. <tr>
  540. <td width="50%">
  541. <strong>User Delete</strong><br/>
  542. <img width="100%" alt="User Delete" src="/demo-screenshots/13-User-Delete-Lite-Mode.png" />
  543. </td>
  544. <td width="50%">
  545. <!-- Reserved for future screenshot -->
  546. </td>
  547. </tr>
  548. </table>
  549. ### 📝 Content Management - CMS
  550. <table>
  551. <tr>
  552. <td width="50%">
  553. <strong>Posts List</strong><br/>
  554. <img width="100%" alt="Users List (Light mode)" src="/demo-screenshots/31-Post-List-Lite-Mode.png"/>
  555. </td>
  556. <td width="50%">
  557. <strong>Post Create</strong><br/>
  558. <img width="100%" alt="Users List (Dark mode)" src="/demo-screenshots/30-Post-List-Dark-Mode.png" />
  559. </td>
  560. </tr>
  561. <tr>
  562. <td width="50%">
  563. <strong>Pages List</strong><br/>
  564. <img width="100%" alt="Users List (Light mode)" src="/demo-screenshots/38-Pages-List-Lite-Mode.png"/>
  565. </td>
  566. <td width="50%">
  567. <strong>Page Edit</strong><br/>
  568. <img width="100%" alt="Users List (Dark mode)" src="/demo-screenshots/39-Pages-Edit-Dark-Mode.png" />
  569. </td>
  570. </tr>
  571. <tr>
  572. <td width="50%">
  573. <strong>Category List & Create</strong><br/>
  574. <img width="100%" alt="Category List & Create" src="/demo-screenshots/34-Category-List-Lite-Mode.png"/>
  575. </td>
  576. <td width="50%">
  577. <strong>Category Edit</strong><br/>
  578. <img width="100%" alt="Category Edit" src="/demo-screenshots/35-Category-Edit-Dark-Mode.png" />
  579. </td>
  580. </tr>
  581. <tr>
  582. <td width="50%">
  583. <strong>Tag List & Create</strong><br/>
  584. <img width="100%" alt="Tag Create" src="/demo-screenshots/36-Tags-List-Lite-Mode.png"/>
  585. </td>
  586. <td width="50%">
  587. <strong>Tag Edit</strong><br/>
  588. <img width="100%" alt="Tag Delete" src="/demo-screenshots/37-Tags-Edit-Dark-Mode.png" />
  589. </td>
  590. </tr>
  591. </table>
  592. ### 📁 Media Management
  593. <table>
  594. <tr>
  595. <td width="50%">
  596. <strong>Media List (Light Mode)</strong><br/>
  597. <img width="100%" alt="Media List" src="/demo-screenshots/60-Media-List-Lite-Mode.png"/>
  598. </td>
  599. <td width="50%">
  600. <strong>Media List (Dark Mode)</strong><br/>
  601. <img width="100%" alt="Media List Dark" src="/demo-screenshots/61-Media-List-Dark-Mode.png"/>
  602. </td>
  603. </tr>
  604. </table>
  605. ### 🤖 AI Content Generation
  606. <table>
  607. <tr>
  608. <td width="50%">
  609. <strong>AI Providers Settings</strong><br/>
  610. <img width="100%" alt="AI Content Generation" src="/demo-screenshots/70-AI-Providers-Lite-Mode-Post.png"/>
  611. </td>
  612. <td width="50%">
  613. <strong>AI Providers Settings</strong><br/>
  614. <img width="100%" alt="Inline AI" src="/demo-screenshots/71-Inline-AI-Editor.png"/>
  615. </td>
  616. </tr>
  617. </table>
  618. Use inline AI inside the admin for drafting and editing. For full site management from **Cursor**, **Claude Desktop**, or **Claude Code**, enable the MCP server under **Settings → MCP** — see [Develop & Manage with AI (MCP)](#-develop--manage-your-site-with-ai-mcp) above.
  619. ### 📧 Email Management
  620. <table>
  621. <tr>
  622. <td width="50%">
  623. <strong>Email Connections</strong><br/>
  624. <img width="100%" alt="Email Connections" src="/demo-screenshots/72-Email-Connections-Lite-Mode.png"/>
  625. </td>
  626. <td width="50%">
  627. <strong>Email Templates</strong><br/>
  628. <img width="100%" alt="Email Templates" src="/demo-screenshots/73-Email-Templates-Lite-Mode.png"/>
  629. </td>
  630. </tr>
  631. <tr>
  632. <td width="50%">
  633. <strong>Email Template Create</strong><br/>
  634. <img width="100%" alt="Email Template Create" src="/demo-screenshots/74-Email-Templates-Create-Dark-Mode.png"/>
  635. </td>
  636. <td width="50%">
  637. <strong>Notifications Settings</strong><br/>
  638. <img width="100%" alt="Notifications Settings" src="/demo-screenshots/75-Notifications-Lite-Mode.png"/>
  639. </td>
  640. </tr>
  641. </table>
  642. ### 🧩 Module Management
  643. <table>
  644. <tr>
  645. <td width="50%">
  646. <strong>Module List</strong><br/>
  647. <img width="100%" alt="Module List" src="/demo-screenshots/14-Module-List.png"/>
  648. </td>
  649. <td width="50%">
  650. <strong>Install Module</strong><br/>
  651. <img width="100%" alt="Install Module" src="/demo-screenshots/15-Module-Install.png"/>
  652. </td>
  653. </tr>
  654. <tr>
  655. <td width="50%">
  656. <strong>Module Detail</strong><br/>
  657. <img width="100%" alt="Module Detail" src="/demo-screenshots/16-Module-Detail-Lite-Mode.png"/>
  658. </td>
  659. <td width="50%">
  660. <!-- Reserved for future module screenshot -->
  661. </td>
  662. </tr>
  663. </table>
  664. ### ⚙️ Settings Pages
  665. <table>
  666. <tr>
  667. <td width="50%">
  668. <strong>General Settings</strong><br/>
  669. <img width="100%" alt="General Settings" src="/demo-screenshots/40-Settings-General.png"/>
  670. </td>
  671. <td width="50%">
  672. <strong>Site Appearance</strong><br/>
  673. <img width="100%" alt="Site Appearance" src="/demo-screenshots/41-Settings-Site-Appearance-Dark-Mode.png"/>
  674. </td>
  675. </tr>
  676. <tr>
  677. <td width="50%">
  678. <strong>Content Settings</strong><br/>
  679. <img width="100%" alt="Content Settings" src="/demo-screenshots/42-Settings-Content.png"/>
  680. </td>
  681. <td width="50%">
  682. <strong>Integration Settings</strong><br/>
  683. <img width="100%" alt="Integration Settings" src="/demo-screenshots/43-Settings-Integration.png"/>
  684. </td>
  685. </tr>
  686. <tr>
  687. <td width="50%">
  688. <strong>Security Settings</strong><br/>
  689. <img width="100%" alt="Security Settings" src="/demo-screenshots/44-Settings-Performance-Security.png"/>
  690. </td>
  691. </tr>
  692. </table>
  693. ### 🌐 Translations Pages
  694. <table>
  695. <tr>
  696. <td width="50%">
  697. <strong>Translations List (Light Mode)</strong><br/>
  698. <img width="100%" alt="Translations List" src="/demo-screenshots/50-Translation-List-Lite-Mode.png" />
  699. </td>
  700. <td width="50%">
  701. <strong>Translations List (Dark Mode)</strong><br/>
  702. <img width="100%" alt="Translations List Dark" src="/demo-screenshots/51-Translation-List-Dark-Mode.png" />
  703. </td>
  704. </tr>
  705. </table>
  706. ### 📊 Monitoring
  707. <table>
  708. <tr>
  709. <td width="50%">
  710. <strong>Action Logs</strong><br/>
  711. <img width="100%" alt="Action Logs" src="/demo-screenshots/20-Action-Log-List.png"/>
  712. </td>
  713. <td width="50%">
  714. <strong>Laravel Pulse</strong><br/>
  715. <img width="100%" alt="Laravel Pulse" src="/demo-screenshots/91-Laravel-Pulse-Dashboard-for-Monitoring.png"/>
  716. </td>
  717. </tr>
  718. </table>
  719. ### 🧩 Rest API Management
  720. <table>
  721. <tr>
  722. <td width="50%">
  723. <strong>Rest API</strong><br/>
  724. <img width="100%" alt="Rest API" src="/demo-screenshots/120-Rest-API-Documentation.png"/>
  725. </td>
  726. <td width="50%">
  727. <strong>Rest API Login</strong><br/>
  728. <img width="100%" alt="Rest API Login" src="/demo-screenshots/121-Rest-API-Login.png"/>
  729. </td>
  730. </tr>
  731. </table>
  732. ### 🔧 Other Pages / Sections / Tests
  733. <table>
  734. <tr>
  735. <td width="50%">
  736. <strong>Custom Error Pages</strong><br/>
  737. <img width="100%" alt="Custom Error Pages" src="/demo-screenshots/100-Custom-Error-Pages.png"/>
  738. </td>
  739. <td width="50%">
  740. <strong>Post activity Chart</strong><br/>
  741. <img width="100%" alt="Post activity Chart" src="/demo-screenshots/102-Post-activity-Chart.png"/>
  742. </td>
  743. </tr>
  744. <tr>
  745. <td width="50%">
  746. <strong>Pest, Pint, Rector, PHPstan tests</strong><br/>
  747. <img width="100%" alt="Pest, Pint, Rector, PHPstan tests" src="/demo-screenshots/103-Unit-Tests-Demo.png"/>
  748. </td>
  749. </tr>
  750. </table>
  751. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  752. ## 🔗 Live Demo
  753. https://laradashboard.com/try-demo/
  754. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  755. ## ✨ Premium Features
  756. Visit [laradashboard.com](https://laradashboard.com) for premium modules — **CRM**, **HRM**, **Course Management**, **Project Management** and more. Each premium module ships with the same CRUD generator, hooks, and test scaffolding as the core.
  757. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  758. ## 🧩 Core modules
  759. - **Task Manager** - https://github.com/laradashboard/TaskManager - Basic Task Manager module for Lara Dashboard | Standard Starter Module for Lara Dashboard.
  760. - **User Avatar** - https://github.com/laradashboard/UserAvatar - A very simple module create an avatar for a user. Handle migration, entries/updates in user forms and so on.
  761. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  762. ## 📦 Module Development
  763. Lara Dashboard uses [nwidart/laravel-modules](https://laravelmodules.com/) for modular architecture. Modules are self-contained packages with pre-compiled assets - no npm required on the server.
  764. ### Quick Start
  765. ```bash
  766. # Create a new module
  767. php artisan module:make Blog
  768. # Build and package for distribution
  769. php artisan module:zip Blog
  770. # Output: Blog-v1.0.0.zip
  771. ```
  772. [Learn module development documentation](https://laradashboard.com/docs/main/developer-guide/module-development)
  773. ### CRUD Generator
  774. Rapidly scaffold complete CRUD operations with a single command.
  775. ```bash
  776. php artisan module:make-crud Blog --model=Article --fields="title:string,author:string,content:text,is_published:boolean"
  777. ```
  778. **What gets generated:**
  779. - ✅ Model with fillable fields and casts
  780. - ✅ Datatable with sorting, searching, pagination
  781. - ✅ Index, Show, Create, Edit Livewire components
  782. - ✅ Blade views with breadcrumb navigation
  783. - ✅ Routes (index, create, show, edit)
  784. - ✅ Sidebar menu item
  785. [Learn more CRUD generator documentation](https://laradashboard.com/docs/main/developer-guide/crud-generator)
  786. ### Installing Modules
  787. **Via Web UI:** Upload ZIP at **Modules → Install Module** (assets publish automatically)
  788. **Via CLI:**
  789. ```bash
  790. unzip Blog-v1.0.0.zip -d modules/
  791. php artisan module:enable Blog
  792. ```
  793. **[📖 Full Module Development Guide](https://laradashboard.com/docs/main/developer-guide/module-development)** - Covers module structure, Tailwind CSS setup, building, packaging, and best practices.
  794. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  795. ## 👥 Contributing
  796. Want to contribute? Fork the project, make your changes, and submit a pull request. Even small improvements to documentation are appreciated!
  797. Please be sure to read our [Contribution Guide](CONTRIBUTING.md) before submitting your PR.
  798. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  799. ## ➶ Coding Standards
  800. ✨ Following a consistent coding standard ensures code quality, readability, and easier collaboration for everyone.
  801. 📏 Please be sure to read our [Contribution Guide](Coding-Standard.md) before submitting your PR.
  802. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  803. ### 🌟 Top contributors:
  804. <a href="https://github.com/laradashboard/laradashboard/graphs/contributors">
  805. <img src="https://contrib.rocks/image?repo=laradashboard/laradashboard" alt="contrib.rocks image" />
  806. </a>
  807. ### ✩ Growth Story
  808. [![Star History Chart](https://star-history.dera.page/svg?repos=laradashboard/laradashboard&type=Date)](https://star-history.dera.page/#laradashboard/laradashboard&Date)
  809. ## 💖 Support
  810. If you like my work you may consider buying me a ☕ / 🍕
  811. <a href="https://www.patreon.com/maniruzzaman" target="_blank" title="Buy Me A Coffee">
  812. Go to Patreon
  813. </a>
  814. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  815. ## 📞 Connect
  816. - Join Facebook Community (For any questions, latest updates) - https://www.facebook.com/groups/laradashboard
  817. - Linkedin Community - https://www.linkedin.com/groups/14690156
  818. - Youtube channel (For tutorials) - https://www.youtube.com/@laradashboard
  819. - Maniruzzaman Akash - [@LinkedIn](https://www.linkedin.com/in/maniruzzamanakash) | manirujjamanakash@gmail.com
  820. <p align="right">(<a href="#readme-top">back to top</a>)</p>
  821. <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
  822. [contributors-shield]: https://img.shields.io/github/contributors/laradashboard/laradashboard.svg?style=for-the-badge
  823. [contributors-url]: https://github.com/laradashboard/laradashboard/graphs/contributors
  824. [forks-shield]: https://img.shields.io/github/forks/laradashboard/laradashboard.svg?style=for-the-badge
  825. [forks-url]: https://github.com/laradashboard/laradashboard/network/members
  826. [stars-shield]: https://img.shields.io/github/stars/laradashboard/laradashboard.svg?style=for-the-badge
  827. [stars-url]: https://github.com/laradashboard/laradashboard/stargazers
  828. [issues-shield]: https://img.shields.io/github/issues/laradashboard/laradashboard.svg?style=for-the-badge
  829. [issues-url]: https://github.com/laradashboard/laradashboard/issues
  830. [license-shield]: https://img.shields.io/github/license/laradashboard/laradashboard.svg?style=for-the-badge
  831. [license-url]: https://github.com/laradashboard/laradashboard/blob/master/LICENSE.txt
  832. [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
  833. [linkedin-url]: https://linkedin.com/in/maniruzzamanakash
  834. [release-shield]: https://img.shields.io/github/v/release/laradashboard/laradashboard?style=for-the-badge&color=success
  835. [release-url]: https://github.com/laradashboard/laradashboard/releases/latest
  836. [php-shield]: https://img.shields.io/badge/PHP-8.3%20%7C%208.4-777BB4?style=for-the-badge&logo=php&logoColor=white
  837. [php-url]: https://www.php.net
  838. [laravel-shield]: https://img.shields.io/badge/Laravel-12.x-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
  839. [laravel-url]: https://laravel.com
  840. [tailwind-shield]: https://img.shields.io/badge/Tailwind_CSS-v4-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white
  841. [tailwind-url]: https://tailwindcss.com
  842. [livewire-shield]: https://img.shields.io/badge/Livewire-3.x-FB70A9?style=for-the-badge&logo=laravel&logoColor=white
  843. [livewire-url]: https://livewire.laravel.com
  844. [product-screenshot]: images/screenshot.png
  845. [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
  846. [Next-url]: https://nextjs.org/
  847. [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
  848. [React-url]: https://reactjs.org/
  849. [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
  850. [Vue-url]: https://vuejs.org/
  851. [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
  852. [Angular-url]: https://angular.io/
  853. [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
  854. [Svelte-url]: https://svelte.dev/
  855. [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
  856. [Laravel-url]: https://laravel.com
  857. [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
  858. [Bootstrap-url]: https://getbootstrap.com
  859. [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
  860. [JQuery-url]: https://jquery.com
  861. [PHP.com]: https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white
  862. [PHP-url]: https://www.php.net
  863. [JavaScript.com]: https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black
  864. [JavaScript-url]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
  865. [MySQL.com]: https://img.shields.io/badge/MySQL-4479A1?style=for-the-badge&logo=mysql&logoColor=white
  866. [MySQL-url]: https://www.mysql.com
  867. [TailwindCSS.com]: https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white
  868. [TailwindCSS-url]: https://tailwindcss.com
  869. [AlpineJS.com]: https://img.shields.io/badge/Alpine.js-8BC0D0?style=for-the-badge&logo=alpine.js&logoColor=black
  870. [AlpineJS-url]: https://alpinejs.dev

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.