Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Advaith3600 committed Apr 4, 2022
1 parent 60e103b commit b066921
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 5 deletions.
49 changes: 45 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,52 @@
# Seamless Admin Panel

A seamless django like admin panel setup for Laravel
A seamless Django-like admin panel setup for Laravel. Simple, non-cms table manager for admins.

---
## Installation steps

To publish assets run
1. Require the Package

Run the following command to install the package into your Laravel application:

```shell
composer require advaith/seamless-admin
```

2. Publish assets and config files with:

```shell
php artisan vendor:publish --provider="Advaith\SeamlessAdmin\SeamlessAdminServiceProvider" --tag="assets"
php artisan vendor:publish --provider="Advaith\SeamlessAdmin\SeamlessAdminServiceProvider"
```

This will create a `seamless.php` configuration file within your config folder. This will also publish all the assets
related to this package.

**Note**: If you find the UI or the admin functionalities are not working properly after a `composer update`, run this
command again with the flag `--tag="assets"` to republish the assets. This will override the existing assets with the new ones.

## Usage

Use the provided trait, `SeamlessAdmin`, in any of your models to get started with the package. Example:

```php
<?php

namespace App\Models;

use Advaith\SeamlessAdmin\Traits\SeamlessAdmin;
...

class Post extends Model
{
use SeamlessAdmin;
...
}
```

Et Voila! That's all you have to do to get started. Visit `/admin` to access the admin dashboard after logging in.

![](Screenshot.png)

## Configuration

More configuration options will be added soon. For requesting a new feature, create a new issue with the label `feature-request`.
Binary file added Screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion src/resources/views/partials/sidebar.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ class="{{ str(request()->url())->contains($resolver->parseType($model)) ? 'activ
{{ str(class_basename($model))->plural() }}
</a>
</li>

@empty
<li class="text-center blank">
No tables found.
Expand Down

0 comments on commit b066921

Please sign in to comment.