ServiceDeskKit

https://github.com/jeffersongoncalves/servicedeskkitv5
Admin
ServiceDeskKit is a starter kit built on Laravel and Filament for developing service desk and...
Tokens:3,708
Snippets:52
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Run automated installation script

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Runs the automated installation script that installs Composer dependencies, sets up the environment, generates the application key, configures the database, runs migrations, installs Node.js dependencies, builds assets, and configures Herd if used.

```bash
php install.php
```

--------------------------------

### Set up environment and generate application key

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Copies the example environment file and generates the application encryption key.

```bash
cp .env.example .env
php artisan key:generate
```

--------------------------------

### Run the development server

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Starts the Laravel development server.

```bash
php artisan serve
```

--------------------------------

### Create a new app with FilaKit CLI

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Uses the FilaKit CLI to create a new application with the ServiceDeskKit kit. Requires FilaKit CLI to be installed globally via Composer.

```bash
filakit new my-app --kit=jeffersongoncalves/servicedeskkitv5
```

--------------------------------

### Install Composer dependencies

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Installs Composer dependencies for the project.

```bash
composer install
```

--------------------------------

### Install JavaScript dependencies

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Installs JavaScript dependencies using PNPM.

```bash
pnpm install
```

--------------------------------

### Start Sail containers

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Starts the Laravel Sail containers in detached mode. Laravel Sail automatically handles the development server, so `php artisan serve` is not needed.

```bash
./vendor/bin/sail up -d
```

--------------------------------

### Override resources in config/filament-service-desk.php

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Override any resource or widget by specifying your custom class in config/filament-service-desk.php. The example shows overriding the admin ticket resource with CustomTicketResource.

```php
'resources' => [
    'admin' => [
        'ticket' => \App\Filament\Admin\Resources\CustomTicketResource::class,
        // ...
    ],
],
```

--------------------------------

### Navigate to project directory

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Moves into the project directory after cloning.

```bash
cd my-app
```

--------------------------------

### Create a new Laravel app with ServiceDeskKit

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Creates a new Laravel application using the ServiceDeskKit starter kit with MySQL as the database.

```bash
laravel new my-app --using=jeffersongoncalves/servicedeskkitv5 --database=mysql
```

--------------------------------

### Build frontend assets

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Builds frontend assets using PNPM.

```bash
pnpm run build
```

--------------------------------

### Run database migrations

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Runs database migrations after configuring the database in the .env file.

```bash
php artisan migrate
```

--------------------------------

### Copy environment file

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Copies the environment configuration template to create the .env file.

```bash
cp .env.example .env
```

--------------------------------

### Run development server with composer dev or individual commands

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Commands to run the development server. The first command runs all components together; the subsequent commands run each component separately.

```bash
composer dev
```

```bash
php artisan serve
```

```bash
php artisan queue:listen --tries=1
```

```bash
pnpm run dev
```

--------------------------------

### Configure core settings in config/service-desk.php

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Key settings in config/service-desk.php for models, ticket options, and SLA configuration. The 'user' model creates tickets, 'operator' handles them; ticket reference prefix defaults to 'SD', default priority to 'medium', max file size to 10240 KB; SLA is enabled with auto_apply and near_breach_minutes set to 30.

```php
'models' => [
    'user' => \App\Models\User::class,      // Model that creates tickets
    'operator' => \App\Models\Operator::class, // Model that handles tickets
],

'ticket' => [
    'reference_prefix' => 'SD',       // Ticket reference prefix (e.g., SD-00001)
    'default_priority' => 'medium',    // Default priority for new tickets
    'max_file_size' => 10240,          // Max attachment size in KB
],

'sla' => [
    'enabled' => true,
    'auto_apply' => true,              // Automatically apply SLA policies
    'near_breach_minutes' => 30,       // Warning before SLA breach
],
```

--------------------------------

### Create storage link for avatars with php artisan storage:link

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Creates the storage link required for avatar storage. Ensure the filesystem disk is configured and the storage link exists.

```bash
php artisan storage:link
```

--------------------------------

### Configure custom ports in .env

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Configures custom ports for the application, MySQL, Redis, and Mailpit to avoid conflicts with other services.

```bash
# Application Port (ex: 8080)
APP_PORT=8080

# MySQL Port (ex: 3306)
FORWARD_DB_PORT=3306

# Redis Port (ex: 6379)
FORWARD_REDIS_PORT=6379

# Mailpit Port (ex: 1025)
FORWARD_MAILPIT_PORT=1025
```

--------------------------------

### Generate application key

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Generates the application encryption key.

```bash
php artisan key:generate
```

--------------------------------

### Toggle plugin features with fluent methods

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Toggle features per-panel using fluent methods on the plugin. Enable knowledge base, SLA, email channels, service catalog, and set navigation group to 'Service Desk'.

```php
ServiceDeskPlugin::make()
    ->knowledgeBase(true)
    ->sla(true)
    ->emailChannels(true)
    ->serviceCatalog(true)
    ->navigationGroup('Service Desk'),
```

--------------------------------

### Attach to application container

Source: https://github.com/jeffersongoncalves/servicedeskkitv5/blob/main/README.md

Attaches to the application container to run commands inside it.

```bash
./vendor/bin/sail shell
```
Tokens:
Raw