Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/superv/platform

superV Platform for Laravel
https://github.com/superv/platform

admin admin-panel dashboard laravel laravel-admin laravel-extension modular php

Last synced: 2 months ago
JSON representation

superV Platform for Laravel

Awesome Lists containing this project

README

        

# SuperV Platform for Laravel [![Build Status](https://travis-ci.org/superv/platform.svg?branch=master)](https://travis-ci.org/superv/platform)

SuperV is a Laravel package that provides an SPA Admin Panel based on your migration files, without generating or requiring additional files.

Please visit https://superv.github.io for documentation.

Click [here](https://superv.github.io/tutorials/videos.html) for video tutorials.

## Installation

### Requirements
superV has the following requirments:

- Laravel 5.8+ or 6.*
- PHP 7.2.0+
- NPM (If you are willing to customize the frontend)


### Install as a Composer Package

Pull in the latest superV Platform package:
```bash
composer require superv/platform
```

Run the installer
```bash
php artisan superv:install
```

Installer will try to complete the following configurations for you:
- [Configure composer.json for the Merge Plugin](./configuration.html#configure-composer-json-for-the-merge-plugin)
- [Create a full privileged User](./configuration.html#create-a-full-privileged-user)
- [Create the Addons directory](./configuration.html#create-the-addons-directory)

Install the composer package for Admin Panel addon:
```bash
composer require superv/admin-panel
```

Install the Admin Panel
```bash
php artisan addon:install superv.panels.admin
```

You can now navigate to `http://your-base-hostname/admin` using your browser and login with the user credentials you created during the installation process.

### Install as a Fresh Project

Create project with composer in your terminal:
```bash
composer create-project superv/superv-project
```

Your web server should point to project's `public` folder for your hostname (eg: `superv.test`). Just as it would in a normal Laravel application.

Required directory permissions are also same with a normal laravel application with one exception, which is the `addons` folder. So make sure this folder is writable by your web server too.

Next, create a database and add your credentials to your `.env` file:

```text
DB_HOST=localhost
DB_DATABASE=superv
DB_USERNAME=superv
DB_PASSWORD=secret
```

And install superV
```bash
php artisan superv:install
```

Install the Admin Panel
```bash
php artisan addon:install superv.panels.admin
```

You can now navigate to `http://your-base-hostname/admin` using your browser and login with the user credentials you created during the installation process.

## Support
If you any questions, feel free to contact me on [Twitter](https://twitter.com/daliselcuk).

## License
[MIT](https://github.com/superv/superv-platform/blob/master/LICENSE.md)