HelpDeskKit

https://github.com/jeffersongoncalves/helpdeskkitv5
Admin
HelpDeskKit is a starter kit built on Laravel and Filament designed to accelerate the development of...
Tokens:2,821
Snippets:34
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Manual installation commands

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

Manual installation steps: install JavaScript and Composer dependencies, set up environment and generate key, run migrations, build frontend assets, and start the server. Configure the database in the .env file before migrating.

```bash
pnpm install
```

```bash
composer install
```

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

```bash
php artisan migrate
```

```bash
pnpm run build
```

```bash
php artisan serve
```

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

### Create app with FilaKit CLI

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

Simplified setup using the FilaKit CLI. Requires installing FilaKit CLI globally with `composer global require jeffersongoncalves/filakit-cli`.

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

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

### Install with Docker using Laravel Sail

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

Docker installation workflow: create app, move into directory, install Composer dependencies, set up environment, optionally configure custom ports (APP_PORT, FORWARD_DB_PORT, FORWARD_REDIS_PORT, FORWARD_MAILPIT_PORT), start Sail containers, attach to container, generate key, and install JavaScript dependencies. No need to run `php artisan serve` because Sail handles the server.

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

```bash
cd my-app
```

```bash
composer install
```

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

```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
```

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

```bash
./vendor/bin/sail shell
```

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

```bash
pnpm install
```

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

### Run automated installation

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

Automates installation: installs Composer dependencies, sets up environment, generates application key, sets up database, runs migrations, installs Node.js dependencies, builds assets, and configures Herd if used.

```bash
php install.php
```

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

### Create Laravel app with helpdeskkitv5

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

Creates a new Laravel application using the helpdeskkitv5 starter kit with MySQL as the database. Requires PHP 8.3 or higher, Composer, Node.js, and PNPM.

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

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

### Run development server with composer dev

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

Use `composer dev` to run the development server with logs, queues, and asset compilation. Alternatively, run each component separately with `php artisan serve`, `php artisan queue:listen --tries=1`, and `pnpm run dev`.

```bash
# Run the development server with logs, queues and asset compilation
composer dev

# Or run each component separately
php artisan serve
php artisan queue:listen --tries=1
pnpm run dev
```
Tokens:
Raw