voyager-admin/voyager

View on GitHub
README.md

Summary

Maintainability
Test Coverage

<p align="center">
  <img src="./resources/assets/dist/images/helm_dark.svg#gh-light-mode-only" width="400" />
  <img src="./resources/assets/dist/images/helm.svg#gh-dark-mode-only" width="400" />
</p>

<p align="center">
    <a href="https://packagist.org/packages/voyager-admin/voyager">
        <img src="https://poser.pugx.org/voyager-admin/voyager/downloads.svg?format=flat" alt="Total Downloads">
    </a>
    <a href="https://packagist.org/packages/voyager-admin/voyager">
        <img src="https://poser.pugx.org/voyager-admin/voyager/v/stable.svg?format=flat" alt="Latest Stable Version">
    </a>
    <a href="https://packagist.org/packages/voyager-admin/voyager">
        <img src="https://poser.pugx.org/voyager-admin/voyager/license.svg?format=flat" alt="License">
    </a>
    <a href="https://codeclimate.com/github/voyager-admin/voyager/maintainability">
        <img src="https://api.codeclimate.com/v1/badges/3e0cebb42838d9344097/maintainability" alt="Maintainability">
    </a>
    <a href="https://codeclimate.com/github/voyager-admin/voyager/test_coverage">
        <img src="https://api.codeclimate.com/v1/badges/3e0cebb42838d9344097/test_coverage" alt="Test coverage">
    </a>
</p>

<p align="center">
    <h1>Voyager - The Missing Laravel Admin</h1>
    <a href="https://voyager-admin.com/" target="_blank">Website</a>
    |
    <a href="https://voyager-admin.github.io/voyager" target="_blank">Documentation</a>
    |
    <a href="https://voyager-slack-invitation.herokuapp.com" target="_blank">Slack chat</a>
</p>

<hr>

Laravel Admin & BREAD System (Browse, Read, Edit, Add, & Delete) for Laravel 8 and up!

## Installation Steps

### 1. Require the Package

After creating your new Laravel application you can include the Voyager package with the following command:

```bash
composer require voyager-admin/voyager:"2.x-dev@dev"
```

### 2. Run The Installer

Now we are ready to install Voyager. To do so, run

```bash
php artisan voyager:install
```

And that's it. You can now go to `http://[YOUR URL]/admin` and login with any existing user.