Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poowf/otter
A relatively automatic CRUD backend administration panel for Laravel
https://github.com/poowf/otter
administration backend dashboard eloquent-models hacktoberfest laravel laravel-nova otter
Last synced: 2 months ago
JSON representation
A relatively automatic CRUD backend administration panel for Laravel
- Host: GitHub
- URL: https://github.com/poowf/otter
- Owner: poowf
- License: mit
- Created: 2018-12-04T09:59:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T22:25:37.000Z (about 2 years ago)
- Last Synced: 2024-08-03T05:24:07.107Z (6 months ago)
- Topics: administration, backend, dashboard, eloquent-models, hacktoberfest, laravel, laravel-nova, otter
- Language: CSS
- Homepage:
- Size: 18.8 MB
- Stars: 259
- Watchers: 7
- Forks: 17
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A relatively ottermatic (automatic) CRUD backend administration panel
# Introduction
Otter was created as an open-source alternative to Laravel Nova. The backend administration panel is built with the beautiful tabler template and follows the structure of the popular laravel extension packages like horizon and telescope.
Otter is designed to handle almost everything for you through `OtterResource` files that essentially tie to your Eloquent Models.
# Screenshots
# Installation
Install Otter with [composer](https://getcomposer.org/doc/00-intro.md):
```bash
$ composer require poowf/otter
```
> In Laravel 5.5+, [service providers and aliases are automatically registered](https://laravel.com/docs/packages#package-discovery). If you're using Laravel 5.5+, skip ahead directly to step 2.
Once the composer installation completes, all you need to do is add the service provider. Open `config/app.php`, and make the following changes:
1) Add a new item to the `providers` array:
```php
Poowf\Otter\OtterServiceProvider::class,
```
2) Install all the relevant Otter assets:
> If you are updating Otter, run `php artisan otter:publish` instead
```bash
php artisan otter:install
```
# Usage
Defining the Models to be registered to Otter is very simple. Let's create an `OtterResource` by running the following command:
```bash
php artisan otter:resource User
```
> You may specify a model class name with the `--model` argument
This will generate a `OtterResource` file located in `app/Otter`.
# OtterResource Conventions
This is an example of an `OtterResource` that is generated by the `otter:resource` command, which will be automatically registered by Otter.
```php
'text',
'password' => 'password',
'email' => 'email',
];
}
}
```
You can hide certain fields in the index and single view resources by defining a `hidden` function returning an array of the keys that you would like hidden. An example configuration would be to hide the password field for a User.
```php
[
'create' => [
'name' => 'required|min:4',
'email' => 'required|email',
'password' => 'required',
],
'update' => [
'name' => 'required|min:4',
'email' => 'required|email',
'password' => '',
]
],
'server' => [
'create' => [
'name' => 'required|min:4',
'email' => 'required|email|unique:users',
'password' => 'required',
],
'update' => [
'name' => 'required|string|min:4',
'email' => 'required|email|unique:users,email,' . auth()->user()->id,
'password' => 'required',
]
],
];
}
```
## Relationships
Otter has partial support for Eloquent relationships. You have to define your relationships in the `OtterResource` file and define the Relationship `method name` as the key and the `OtterResource` class name that links to the relationship.
You can also define a custom foreign key if you are not using the Laravel defaults.
The `title` property should be the column of the model that will be displayed in the options list during editing/creating of new resources .
```php
['Company', 'company_id'],
'company' => 'Company',
];
}
}
```
# Authorization
Otter exposes a dashboard at `/otter`. By default, you will only be able to access this dashboard in the local environment. Within your `app/Providers/OtterServiceProvider.php` file, there is a gate method. This authorization gate controls access to Otter in non-local environments. You are free to modify this gate as needed to restrict access to your Otter installation:
```php
/**
* Register the Otter gate.
*
* This gate determines who can access Otter in non-local environments.
*
* @return void
*/
protected function gate()
{
Gate::define('viewOtter', function ($user) {
return in_array($user->email, [
'[email protected]'
]);
});
}
```
# Configuration
After publishing Otter's assets, its primary configuration file will be located at `config/otter.php`.
This configuration file will allow you to configure the middleware for both the `api` and `web` routes that is automatically registered by Otter.
You can also configure the keys of the `Auth::user()` instance for the `name` and `email` properties that is used in the top right dropdown.
The `pagination` configuration value is used to display the number of records in the index pages.
```php
'middleware.web' => ['web'],
'middleware.api' => ['api'],
'pagination' => 20,
'user' => [
'name' => 'name',
'email' => 'email',
],
```
# Extras
A dark/night theme can be enabled by specifying `Otter::night()` in the boot method of the OtterServiceProvider