> For the complete documentation index, see [llms.txt](https://ikdev.gitbook.io/ikpanel/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ikdev.gitbook.io/ikpanel/master.md).

# Getting started

## # Requirements

This package require [Laravel 5.6](https://github.com/laravel/laravel)

## # Installation

### Development inclusion

First of all, you need to create package/ikdev folder in your project root directory and clone ikpanel inside.

```
git clone git@github.com:RobyFerro/ikpanel.git
```

Add repository path in your composer.json

{% code title="composer.json" %}

```
"repositories": [
    {
        "type": "path",
        "url": "packages/ikdev/ikpanel"
    }
],
```

{% endcode %}

### Production inclusion

Edit your composer.json file ad add this:

{% code title="composer.json" %}

```
"repositories": [{
    "type": "github",    
    "url": "git@github.com:RobyFerro/ikpanel.git"
}],
```

{% endcode %}

### Installation

Install ikpanel with your terminal.

{% code title="" %}

```
php composer.phar require ikdev/ikpanel
```

{% endcode %}

Edit auth model in config/auth.php:

{% code title="config/auth.php" %}

```php
'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model' => \ikdev\ikpanel\app\Users::class,
    ],
],
```

{% endcode %}

Execute the followings commands:

```
php composer.phar update && php composer.phar dump-autoload -o
php artisan vendor:publish --tag=fm-config
php artisan vendor:publish --tag=fm-assets
php artisan vendor:publish --tag=ikpanel --force
php artisan migrate
```

## # Conclusion

\
Congratulations, now you're ready to use/integrate ikpanel in your project!

{% hint style="warning" %}
Default ikpanel credentials:

* Username : <boba.fett@ikpanel.eu>
* Password : 0
  {% endhint %}