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

https://github.com/ivanaquino/jet-admin

This package provides an elegant and responsive admin panel and landing page layout for applications using Laravel Jetstream with Livewire
https://github.com/ivanaquino/jet-admin

admin blade dashboard dashboard-templates jetstream jetstream-laravel landing-template laravel laravel-framework laravel-jetstream laravel-package starter starter-template tailwindcss

Last synced: 11 months ago
JSON representation

This package provides an elegant and responsive admin panel and landing page layout for applications using Laravel Jetstream with Livewire

Awesome Lists containing this project

README

          

# JetAdmin

[![Latest Version on Packagist](https://img.shields.io/packagist/v/ivanaquino/jet-admin.svg?style=flat-square)](https://packagist.org/packages/ivanaquino/jet-admin)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ivanaquino/jet-admin/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ivanaquino/jet-admin/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ivanaquino/jet-admin/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ivanaquino/jet-admin/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/ivanaquino/jet-admin.svg?style=flat-square)](https://packagist.org/packages/ivanaquino/jet-admin)

This package provides an elegant and responsive admin panel and landing page layout for applications using Laravel Jetstream with Livewire. It offers a quick and easy way to scaffold your application's administrative interface and landing page, saving you time and effort in the early stages of development.




## Libraries

- [Blade Icons](https://github.com/blade-ui-kit/blade-icons)
- [Blade Hero icons](https://github.com/blade-ui-kit/blade-heroicons)

## Installation

*Note: Flowbite package is not required anymore.*

Are you a visual learner?, check our youtube video [https://youtu.be/yPIGqrF1GAM](https://youtu.be/yPIGqrF1GAM)

You can install the package via composer:

```bash
composer require ivanaquino/jet-admin
```

Add dark model to your tailwind config file `tailwind.config.js`.

```js
{
darkMode: 'class',
...
}
```

It's simple to change main color, you just have to modify the tailwind config file `tailwind.config.js`.

```js
{
theme: {
extend: {
// ...
colors: {
'primary': {
'50': '#eaf5ff',
'100': '#d9ecff',
'200': '#badbff',
'300': '#91c1ff',
'400': '#659bff',
'500': '#4273ff',
'600': '#2149ff',
'700': '#183bec',
'800': '#1533be',
'900': '#1b3494',
'950': '#101d56',
},
},
},
},
}
```

Publish jet-admin javascript

```bash
php artisan vendor:publish --tag="jet-admin-js"
```

Now add jet-admin js to `./resources/js/app.js`

```js
import './vendor/jet_admin';
```

To change navigation items you have to publish config file:

```bash
php artisan vendor:publish --tag="jet-admin-config"
```

This is the contents of the published config file:

```php
return [
/*
|--------------------------------------------------------------------------
| Landing Navigation
|--------------------------------------------------------------------------
|
| name: Could be a string or a translation key this will be passed through the __() function
| route: Could be a url or a route name
|
|*/
'landing_navigation' => [
[
'name' => 'Home',
'route' => '/',
],
],

/*
|--------------------------------------------------------------------------
| Dashboard Navigation
|--------------------------------------------------------------------------
|
| Items in this array will be used to generate the dashboard sidebar
| - name: The label that will be displayed in the sidebar
| - route: Could be a route name or a URL
| - active_route: The route name or URL that will be used to determine if the item is active
| - icon: The icon that will be displayed in the sidebar, Heroicons' name.
|
|*/
'dashboard_navigation' => [
[
'name' => 'Dashboard',
'route' => 'dashboard',
'active_route' => 'dashboard*',
'icon' => 'home',
],
[
'name' => 'Profile',
'route' => 'profile.show',
'active_route' => 'profile.show',
'icon' => 'user',
],
// [
// 'name' => 'Url example',
// 'route' => 'my-url',
// 'active_route' => 'my-url',
// 'icon' => 'shield-exclamation',
// ],
],
];
```

Optionally, you can publish the views using

```bash
php artisan vendor:publish --tag="jet-admin-views"
```

## Usage

Landing layout

```blade

Your own content goes here...

```

Dashboard layouts

```blade

Your dashboard content goes here...

{{-- OR --}}

Your dashboard content goes here...

```

## Testing

```bash
composer test
```

## Changelog

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

## Contributing

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

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Ivan Aquino](https://github.com/IvanAquino)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.