Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/laravel-backpack/menucrud

An admin panel for menu items, using Backpack\CRUD on Laravel 6 or 7.
https://github.com/laravel-backpack/menucrud

Last synced: 3 days ago
JSON representation

An admin panel for menu items, using Backpack\CRUD on Laravel 6 or 7.

Host: GitHub
URL: https://github.com/laravel-backpack/menucrud
Owner: Laravel-Backpack
License: other
Created: 2016-05-26T06:23:56.000Z (over 8 years ago)
Default Branch: main
Last Pushed: 2024-09-04T14:03:42.000Z (4 months ago)
Last Synced: 2024-12-24T02:48:12.139Z (10 days ago)
Language: Blade
Homepage: http://backpackforlaravel.com
Size: 99.6 KB
Stars: 196
Watchers: 11
Forks: 54
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Support: .github/support.yml

Awesome Lists containing this project

README

        # Backpack\MenuCRUD

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE.md)

[![Build Status][ico-travis]][link-travis]

[![Coverage Status][ico-scrutinizer]][link-scrutinizer]

[![Quality Score][ico-code-quality]][link-code-quality]

[![Total Downloads][ico-downloads]][link-downloads]

An admin panel for menu items on Laravel 5 or Laravel 6, using [Backpack\CRUD](https://github.com/Laravel-Backpack/crud). Add, edit, reorder, nest, rename menu items and link them to [Backpack\PageManager](https://github.com/Laravel-Backpack/pagemanager) pages, external link or custom internal link.

Usually used for front-end menus, not back-end. Adding a menu item in MenuCRUD will not add an item in the admin sidebar, though you can easily customize Backpack\Base's ```sidebar.blade.php``` to show all menu items in the db, if you'd like.

> ### Security updates and breaking changes

> Please **[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 every 1-2 months.

## Install

This needs [Backpack\PageManager](https://github.com/Laravel-Backpack/pagemanager) to be installed first. If you haven't already, please do that first.

Since MenuCRUD is just a Backpack\CRUD example, you can choose to install it one of two ways.

**(A) Download and place files in your application** (recommended)

or

**(B) As a package**

The only PRO of installing it as a package is that you may benefit from updates. But the reality is there is very little (if any) bug fixing to do, so you probably won't need to update it, ever.

#### Installation type (A) - download

1) [Download the latest build](https://github.com/Laravel-Backpack/MenuCRUD/archive/master.zip).

2) Paste the 'app' and 'database' folders over your projects (merge them). No file overwrite warnings should come up.

3) Copy the `page_or_link.blade.php` file located in 'resources/views/fields' folder to your project's 'resources/views/vendor/backpack/crud/fields' folder. No file overwrite warnings should come up.

4) Replace all mentions of 'Backpack\MenuCRUD\app' in the pasted files with your application's namespace ('App' if you haven't changed it):

- app/Http/Controllers/Admin/MenuItemCrudController.php

- app/Models/MenuItem.php

5) Run the migration to have the database table we need:

```

php artisan migrate

```

6) Add MenuCRUD to your routes file:

```

Route::group(['prefix' => config('backpack.base.route_prefix', 'admin'), 'middleware' => ['web', 'auth'], 'namespace' => 'Admin'], function () {

    // Backpack\MenuCRUD

    Route::crud('menu-item', 'MenuItemCrudController');

});

```

7) [optional] Add a menu item for it:

```

# For Backpack v6

php artisan backpack:add-menu-content ""

# For Backpack v5 or v4

php artisan backpack:add-sidebar-content "
 Menu"

```

#### Installation type (B) - package

1) In your terminal, run:

``` bash

composer require backpack/menucrud

```

2) Publish the migration:

```

php artisan vendor:publish --provider="Backpack\MenuCRUD\MenuCRUDServiceProvider"

```

3) Run the migration to have the database table we need:

```

php artisan migrate

```

4) [optional] Add a menu item for it:

```

# For Backpack v6

php artisan backpack:add-menu-content ""

# For Backpack v5 or v4

php artisan backpack:add-sidebar-content "
 Menu"

```

#### Usage in your template

Here's a simple example to use in your frontend:

You can access item children with `$item->children`

```

@foreach (\App\MenuItem::getTree(); as $item)

  

     {{ $item->name }}

  

@endforeach

```

For Installation type (B), change the namespace to `Backpack\MenuCRUD\app\Models`.

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Overwriting functionality

If you've used installation type A and need to modify how this works in a project:

- create a ```routes/backpack/menucrud.php``` file; the package will see that, and load _your_ routes file, instead of the one in the package;

- create controllers/models that extend the ones in the package, and use those in your new routes file;

- modify anything you'd like in the new controllers/models;

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Please **[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 every 1-2 months.

## Credits

- [Cristian Tabacitu][link-author]

- [All Contributors][link-contributors]

## License

Backpack is free for non-commercial use and 49 EUR/project for commercial use. Please see [License File](LICENSE.md) and [backpackforlaravel.com](https://backpackforlaravel.com/#pricing) for more information.

## 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 software in its niche - 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 this. This is _what we do_. [Contact us - let's see if we can work together](https://backpackforlaravel.com/need-freelancer-or-development-team).

[ico-version]: https://img.shields.io/packagist/v/backpack/MenuCRUD.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-dual-blue?style=flat-square

[ico-travis]: https://img.shields.io/travis/Laravel-Backpack/MenuCRUD/master.svg?style=flat-square

[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/Laravel-Backpack/MenuCRUD.svg?style=flat-square

[ico-code-quality]: https://img.shields.io/scrutinizer/g/Laravel-Backpack/MenuCRUD.svg?style=flat-square

[ico-downloads]: https://img.shields.io/packagist/dt/backpack/MenuCRUD.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/backpack/MenuCRUD

[link-travis]: https://travis-ci.org/Laravel-Backpack/MenuCRUD

[link-scrutinizer]: https://scrutinizer-ci.com/g/Laravel-Backpack/MenuCRUD/code-structure

[link-code-quality]: https://scrutinizer-ci.com/g/Laravel-Backpack/MenuCRUD

[link-downloads]: https://packagist.org/packages/backpack/MenuCRUD

[link-author]: https://github.com/tabacitu

[link-contributors]: ../../contributors