README

Quickly build an admin panel for your Eloquent models, then customize every little detail.

Among the FREE features of each admin interface: - [List](https://backpackforlaravel.com/docs/5.x/crud-operation-list-entries) operation - 24 column types - 1-1, 1-n and n-n relationships - table view with search, pagination - click column header to sort by it - custom buttons - details row - easily create new column types - easily override an existing column type - [Create](https://backpackforlaravel.com/docs/5.x/crud-operation-create) / [Update](https://backpackforlaravel.com/docs/5.x/crud-operation-update) operations - 29 field types - back-end validation using Laravel Form Requests - translatable models (multi-language) - have multiple fields per line - split fields into tabs - [Delete](https://backpackforlaravel.com/docs/5.x/crud-operation-delete) operation - [Reorder](https://backpackforlaravel.com/docs/5.x/crud-operation-reorder) operation - [Revise](https://backpackforlaravel.com/docs/5.x/crud-operation-revisions) operation (aka. audit log) But professionals don't love Backpack just because it's feature-packed. They also love it because it's **ridiculously easy to override a functionality**. Generally, you just need to create a function (or blade file) with the right name. Yes, it can be _that_ easy. > Need more complex features? Purchase [Backpack PRO](https://backpackforlaravel.com/pricing), our closed-source paid add-on. It will add **5 more operations, 10 filters, 28 more fields, 6 more columns and 1 more widget**. For more info, see our [FREE vs PRO comparison table](https://backpackforlaravel.com/docs/5.x/features-free-vs-paid). We believe it's everything you need to build admin panels of _any_ complexity. ## Links

Website   •   Documentation   •   Add-ons   •   Pricing   •   Services   •   Stack Overflow   •   Blog   •   Newsletter

## Demo Please see [demo.backpackforlaravel.com](https://demo.backpackforlaravel.com/admin). ## Getting Started Start with the ["Introduction" page in our docs](https://backpackforlaravel.com/docs/5.x/introduction) in our docs. It will explain what you can do with Backpack, and let you choose a guide, depending on how you like to learn: - a 31-minute ["Getting Started" video course](https://backpackforlaravel.com/docs/5.x/getting-started-videos); - a 20-minute ["Getting Started" text course](https://backpackforlaravel.com/docs/5.x/getting-started-basics); - a 4-day, 5min/day ["Getting Started" drip email course](https://sendy.digitallyhappy.com/subscription?f=jlldf83763papd2Ifee0838Xs65TkXSvi17yEAuEnJiNj9ct53p5tikGHM4OkvpCeFUCbwcEYRt763ZSTILFXRWWEQ); ## Install For the current version (recommended): - [Install Backpack v5 on Laravel 9 or 8](https://backpackforlaravel.com/docs/5.x/installation); For the previous versions (not recommended): - [Install Backpack 4.1 on Laravel 6, 7 or 8](https://backpackforlaravel.com/docs/4.1/installation) - last feature update was 1st Jan 2021; - [Install Backpack 4.0 on Laravel 5.8, 6 or 7](https://backpackforlaravel.com/docs/4.0/installation) - last feature update was 21st Apr 2020; - [Install Backpack 3.6 on Laravel 5.8 or 6.x](https://backpackforlaravel.com/docs/3.6/installation) - last feature update was 17th Sep 2019; - [Install Backpack 3.5 on Laravel 5.5, 5.6, 5.7](https://backpackforlaravel.com/docs/3.5/installation) - last feature update was 27th Feb 2019; - [Install Backpack 3.x on Laravel 5.4](https://laravel-backpack.readme.io/docs/install-on-laravel-54) - last feature update was 27 Sep 2017; - [Install Backpack 3.x on Laravel 5.3](https://laravel-backpack.readme.io/docs/installation-on-laravel-53) - last feature update was 02 Feb 2017; - [Install Backpack 3.x on Laravel 5.2](https://laravel-backpack.readme.io/docs/installation) - deprecated, lacks a lot of features; ## Change Log For v5.x and v4.x please see [the Releases tab](https://github.com/Laravel-Backpack/CRUD/releases). For previous versions (Backpack <=4.0.x), please see our old [CHANGELOG](CHANGELOG.md) file. ## Security > It's _heavily_ recommended that you **[subscribe to the Backpack Newsletter](http://backpackforlaravel.com/newsletter)** so you can find out about any security updates, breaking changes or major features. We send an email about 1-2 emails per year. Sometimes less. If you discover any security related issues, please email hello@backpackforlaravel.com instead of using the issue tracker. Alternatively, please disclose the issue on [huntr.dev](https://huntr.dev/) to also get a small bounty ($25-40). ## License Starting with v5, Backpack has become open-core. Its features have been separated into two packages: - **Backpack CRUD is licensed under the [MIT License](LICENSE.md)** (open-source free software); it is perfect if you're building a simple admin panel - it's packed with features! it's also perfect if you're building an open-source project, the permissive license allows you to do whatever you want; - **Backpack PRO is licensed under our [EULA](https://backpackforlaravel.com/eula)**; it is a closed-source, paid add-on; [PRO](https://backpackforlaravel.com/products/pro) will be useful when your admin panel needs grow, because it adds adds A LOT of features for complex use cases (see our [FREE vs PRO comparison](https://backpackforlaravel.com/docs/5.x/features-free-vs-paid)); [Our documentation](https://backpackforlaravel.com/docs) covers both CRUD and PRO, with all the PRO features clearly labeled PRO. ## Versioning Starting with Backpack v5, all our packages follow [semantic versioning](https://semver.org/). Here's what `major.minor.patch` (eg. `5.0.1`) means for us: - `major` - breaking changes, major new features, complete rewrites; released **once a year**, in February; it adds features that were previously impossible and upgrades our dependencies; upgrading is done by following our clear and detailed upgrade guides; - `minor` - new features, released in backwards-compatible ways; **every few months**; update takes seconds; - `patch` - bug fixes & small non-breaking changes; historically **every week**; update takes seconds; When we release a new Backpack\CRUD version, all paid addons receive support for it the same day. When you buy a premium Backpack addon, you get access to not only _updates_, but also _upgrades_ (for 12mo), that means that... **any time you buy a Backpack addon, it is very likely that you're not only buying the _current_ version** (`v5` at the moment), **but also the upgrade to the _next version_** (`v6` for example). ## Contributing Guidelines This project stands by [The Whole Fruit Manifesto](https://github.com/the-whole-fruit/manifesto). We believe that “_writing good code_” is not only about “_writing good code_”. It’s also about the words around it. That’s why, to make sure your contribution is well received, we ask you to [read and keep in mind the ONE=MOR framework and guidelines](https://github.com/the-whole-fruit/manifesto) when writing comment blocks, PR titles, PR descriptions, and in general, when writing to our community. For tasks & details about how you can help our project, please see [CONTRIBUTING](CONTRIBUTING.md). ## Credits - [Cristian Tabacitu](http://tabacitu.ro) - creator & lead maintainer; - [Pedro Martins](https://github.com/pxpm) - maintainer; - [António Almeida](https://github.com/promatik) - maintainer; - [All Contributors][link-contributors] Special thanks go to: - [Owen Melbourne](https://github.com/OwenMelbz), [Oliver Ziegler](https://github.com/OliverZiegler), [Thomas Swonke](https://github.com/tswonke), [Catalin Tudorache](https://github.com/tumf87), [Abby Janke](https://github.com/AbbyJanke), [David Lloyd](https://github.com/lloy0076) - A LOT of new features, bug fixing, support, feedback and code review; - [Łukasz Holeczek](https://coreui.io/) - creator of CoreUI (used in Backpack v4); - [Abdullah Almsaeed](https://adminlte.io/) - creator of AdminLTE (used in Backpack v3); - [John Skoumbourdis](http://www.grocerycrud.com/) - Grocery CRUD for CodeIgniter was a big inspiration for Backpack v1 & v2; - [Taylor Otwell](https://github.com/taylorotwell) & Laravel contributors (of course); ## Hire us We've spend more than 10.000 hours creating, polishing and maintaining administration panels on Laravel. We've developed e-Commerce, e-Learning, ERPs, social networks, payment gateways and much more. We've worked on admin panels _so much_, that we've created one of the most popular packages for Laravel - just from making public what was repetitive in our projects. If you are looking for a developer/team to help you build an admin panel on Laravel, look no further. You'll have a difficult time finding someone with more experience & enthusiasm for admin panels. This is _what we do_. [Contact us](https://backpackforlaravel.com/need-freelancer-or-development-team). [ico-version]: https://img.shields.io/packagist/v/dick/crud.svg?style=flat-square [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square [ico-downloads]: https://img.shields.io/packagist/dt/tabacitu/crud.svg?style=flat-square [link-packagist]: https://packagist.org/packages/backpack/crud [link-downloads]: https://packagist.org/packages/backpack/crud [link-author]: https://tabacitu.ro [link-contributors]: ../../contributors # crud-vsmov