Tutorial - Laravel Console Starter - Knowledge of Laravel

Inleiding

In deze tutorial bouw je met revolution/laravel-console-starter een Laravel-applicatie met custom artisan-commands. De voordelen van deze starter kit:

Snelle setup — Je begint direct met het ontwikkelen van consoleapps, zonder complexe configuratie
Laravel-ecosysteem — Je gebruikt de rijke functionaliteit van Laravel, zoals taskscheduling, databases en notificaties
Artisan-commands — Met het krachtige Artisan-systeem van Laravel maak en beheer je eenvoudig eigen commands
Testbaarheid — Je schrijft tests voor je commands met het testframework van Laravel

Vereisten

Installeer de volgende software.

PHP ^8.3
Composer (https://getcomposer.org/)
Laravel Installer (composer global require laravel/installer)

Het project opzetten

Een nieuw project maken

Voer in je terminal het volgende command uit.

laravel new my-app --using=revolution/laravel-console-starter --no-interaction

De directory my-app wordt aangemaakt en de basisstructuur van de consoleapp wordt opgezet.Tijdens de installatie wordt het volgende automatisch uitgevoerd.

Het genereren van een .env-bestand op basis van .env.example
Het instellen van de applicatiesleutel met php artisan key:generate

De belangrijkste directorystructuur:

my-app/
├── app/Console/Commands/   # Hier plaats je custom commands
├── .github/workflows/
│   └── cron.yml            # Voorbeeld van een GitHub Actions-schema
├── config/                 # Applicatieconfiguratie
└── routes/console.php      # Commandregistratie

De omgevingsconfiguratie controleren

Standaard is e-mailverzending ingesteld op loggen (MAIL_MAILER=log).Wil je echt e-mails versturen, configureer dan in het .env-bestand een service zoals Mailgun, Postmark of SES.

Een consolecommand maken

Het command genereren

Maak een nieuw command met het Artisan-command make:command.

php artisan make:command YourCommandName --command=your:command

YourCommandName — De klassenaam van het te maken command (bijvoorbeeld SendDailyReport)
your:command — De aanroepnaam van het command (bijvoorbeeld report:send-daily)

app/Console/Commands/YourCommandName.php wordt gegenereerd.

Het command implementeren

Bewerk het gegenereerde bestand en implementeer je logica. Hieronder een voorbeeld van een Hello World-command.

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Log;

class HelloWorldCommand extends Command
{
    protected $signature = 'hello:world';
    protected $description = 'Displays a hello world message in the log';

    public function handle(): int
    {
        Log::info('Hello, World from Artisan Command!');
        $this->info('Hello, World message has been logged.');
        return Command::SUCCESS;
    }
}

Met $signature definieer je de aanroepnaam van het command en in de handle()-method schrijf je de logica.

Het command uitvoeren

php artisan hello:world

Na het uitvoeren verschijnt het bericht in storage/logs/laravel.log en in de console.

Taskscheduling met GitHub Actions

Met GitHub Actions voer je commands periodiek uit zonder cronjobs op een server.

Het workflowbestand bekijken

De starter kit bevat een vooraf geconfigureerd .github/workflows/cron.yml.

name: cron

on:
  schedule:
    - cron: '0 0 * * *'  # Dagelijks om 0:00 UTC

jobs:
  cron:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: shivammathur/setup-php@v2
        with:
          php-version: 8.5
          coverage: none
      - run: composer install --no-dev -q
      - run: cp .env.example .env
      - run: php artisan key:generate
      - run: php artisan inspire

Het command aanpassen

Vervang php artisan inspire door je eigen command.

- name: Run Command
  run: php artisan your:command

Meerdere commands uitvoeren:

- name: Run Commands
  run: |
    php artisan first:command
    php artisan second:command

Het schema aanpassen

Wijzig de cron-expressie om de uitvoeringsfrequentie in te stellen.

cron-expressie	Uitvoeringsmoment
`0 0 * * *`	Dagelijks om 0:00 UTC
`0 /6 * *`	Elke 6 uur
`0 0 * * 1`	Elke maandag om 0:00

Gevoelige gegevens beheren met secrets

Voor gevoelige gegevens zoals API-sleutels en wachtwoorden gebruik je GitHub-repositorysecrets.Voeg secrets toe via Settings > Secrets and variables > Actions in je GitHub-repository en verwijs ernaar in de workflow.

- name: Run Command with Secrets
  run: php artisan your:command
  env:
    API_KEY: ${{ secrets.API_KEY }}
    DB_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}

Notificaties

Je kunt de resultaten of fouten van commands melden via e-mail, Slack en meer.

Een notificatieklasse maken

php artisan make:notification TaskCompleted

app/Notifications/TaskCompleted.php wordt gegenereerd.

Notificatiekanalen configureren

Publiceer indien nodig de configuratiebestanden.

php artisan config:publish mail
php artisan config:publish services

Een notificatie versturen vanuit een command

<?php

namespace App\Console\Commands;

use App\Notifications\TaskCompleted;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Notification;

class ProcessDataCommand extends Command
{
    protected $signature = 'data:process';
    protected $description = 'Data verwerken en na afronding een notificatie versturen';

    public function handle()
    {
        $this->info('Data wordt verwerkt...');

        // Verwerkingslogica...

        Notification::route('mail', '[email protected]')
            ->notify(new TaskCompleted('Dataverwerking succesvol afgerond'));

        return Command::SUCCESS;
    }
}

Zie de Laravel-notificatiedocumentatie voor details.

Praktische applicatievoorbeelden

Voorbeeld 1: uptime-monitoring van websites met Slack-alerts

Een command dat controleert of websites online zijn en bij een gedetecteerd probleem een alert naar Slack stuurt.

Het Slack-notificatiekanaal installeren

composer require laravel/slack-notification-channel

Het command en de notificatie maken

php artisan make:command MonitorWebsites --command=monitor:websites
php artisan make:notification WebsiteDown

Slack configureren

php artisan config:publish services

Voeg de Slack-webhook-URL toe aan .env.

SLACK_WEBHOOK_URL=https://hooks.slack.com/services/YOUR/WEBHOOK/URL

Werk config/services.php bij.

'slack' => [
    'webhook_url' => env('SLACK_WEBHOOK_URL'),
],

De notificatie implementeren

Bewerk app/Notifications/WebsiteDown.php.

<?php

namespace App\Notifications;

use Illuminate\Notifications\Messages\SlackMessage;
use Illuminate\Notifications\Notification;

class WebsiteDown extends Notification
{
    public function __construct(
        protected string $website,
        protected string $error,
    ) {}

    public function via($notifiable): array
    {
        return ['slack'];
    }

    public function toSlack($notifiable): SlackMessage
    {
        return (new SlackMessage)
            ->error()
            ->content('Website-down-alert!')
            ->attachment(function ($attachment) {
                $attachment->title($this->website)
                           ->content("Fout: {$this->error}")
                           ->timestamp(now());
            });
    }
}

Het command implementeren

Bewerk app/Console/Commands/MonitorWebsites.php.

<?php

namespace App\Console\Commands;

use App\Notifications\WebsiteDown;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Notification;

class MonitorWebsites extends Command
{
    protected $signature = 'monitor:websites {--timeout=10}';
    protected $description = 'Controleert of websites bereikbaar zijn en stuurt bij downtime een Slack-alert';

    protected array $websites = [
        'https://example.com',
        'https://yourwebsite.com',
    ];

    public function handle(): int
    {
        $timeout = (int) $this->option('timeout');
        $webhookUrl = config('services.slack.webhook_url');
        $hasErrors = false;

        foreach ($this->websites as $website) {
            try {
                $response = Http::timeout($timeout)->get($website);
                if ($response->successful()) {
                    $this->info("{$website}: online ✓");
                } else {
                    $error = "HTTP-status: " . $response->status();
                    $this->error("{$website}: down ({$error})");
                    Notification::route('slack', $webhookUrl)
                        ->notify(new WebsiteDown($website, $error));
                    $hasErrors = true;
                }
            } catch (\Exception $e) {
                $this->error("{$website}: fout ({$e->getMessage()})");
                Log::error("Controle van {$website} mislukt", ['error' => $e->getMessage()]);
                Notification::route('slack', $webhookUrl)
                    ->notify(new WebsiteDown($website, $e->getMessage()));
                $hasErrors = true;
            }
        }

        return $hasErrors ? Command::FAILURE : Command::SUCCESS;
    }
}

Schedulen met GitHub Actions

Werk .github/workflows/cron.yml bij.

name: Website Monitoring

on:
  schedule:
    - cron: '*/15 * * * *'  # Elke 15 minuten uitvoeren

jobs:
  monitor:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: shivammathur/setup-php@v2
        with:
          php-version: 8.5
      - run: composer install --no-dev -q
      - run: cp .env.example .env
      - run: php artisan key:generate
      - name: Monitor Websites
        run: php artisan monitor:websites
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

Voorbeeld 2: cryptoportfolio-updates met Discord-notificaties

Een command dat cryptovalutaprijzen ophaalt via de CoinGecko-API en updates verstuurt via een Discord-webhook.

Het Discord-notificatiekanaal installeren

composer require revolution/laravel-notification-discord-webhook

Het command en de notificatie maken

php artisan make:command UpdateCryptoPortfolio --command=crypto:portfolio
php artisan make:notification CryptoPortfolioUpdate

Discord configureren

Voeg de Discord-webhook-URL toe aan .env.

DISCORD_WEBHOOK=https://discord.com/api/webhooks/YOUR/WEBHOOK

Werk config/services.php bij.

'discord' => [
    'webhook' => env('DISCORD_WEBHOOK'),
],

Het command implementeren en uitvoeren

Zie de tutorial in de GitHub-repository voor de gedetailleerde implementatie.

php artisan crypto:portfolio

Voorbeeld 3: websitecontent scrapen met e-mailnotificaties

Een command dat content van een website scrapet en het resultaat per e-mail verstuurt.

Het command en de notificatie maken

php artisan make:command WebScraper --command=scrape:website
php artisan make:notification ScrapingCompleted

E-mail configureren

php artisan config:publish mail

Voeg de e-mailconfiguratie toe aan het .env-bestand.

MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=your_username
MAIL_PASSWORD=your_password
MAIL_ENCRYPTION=tls
[email protected]
MAIL_FROM_NAME="${APP_NAME}"

Het command implementeren en uitvoeren

protected $signature = 'scrape:website {--url=https://example.com} {[email protected]}';

public function handle(): int
{
    $url = $this->option('url');
    $email = $this->option('email');

    $response = Http::timeout(30)->get($url);

    // De content verwerken en de notificatie versturen...
    Notification::route('mail', $email)
        ->notify(new ScrapingCompleted(true, $url, $title, $content));

    return Command::SUCCESS;
}

php artisan scrape:website [email protected]

Volgende stappen

Je hebt nu de basis geleerd van Laravel-consoleapplicaties met revolution/laravel-console-starter. Om je verder te verdiepen:

Verken de Laravel-documentatie — Bekijk in de officiële Laravel-documentatie welke functies je consoleapp kunnen versterken
Implementeer tests — Schrijf tests voor je commands met het testframework van Laravel en waarborg de betrouwbaarheid
Overweeg pakketontwikkeling — Maak je vergelijkbare commands in meerdere projecten, overweeg dan om ze te publiceren als herbruikbaar Laravel-pakket
Blijf op de hoogte — Volg Laravel News en de officiële blog om best practices bij te houden

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter kits

Feeds en RSS

Middleware

Tutorial - Laravel Console Starter

Inleiding

Vereisten

Het project opzetten

Een consolecommand maken

Taskscheduling met GitHub Actions

Notificaties

Praktische applicatievoorbeelden

Voorbeeld 1: uptime-monitoring van websites met Slack-alerts

Voorbeeld 2: cryptoportfolio-updates met Discord-notificaties

Voorbeeld 3: websitecontent scrapen met e-mailnotificaties

Volgende stappen

​Inleiding

​Vereisten

​Het project opzetten

​Een consolecommand maken

​Taskscheduling met GitHub Actions

​Notificaties

​Praktische applicatievoorbeelden

​Voorbeeld 1: uptime-monitoring van websites met Slack-alerts

​Voorbeeld 2: cryptoportfolio-updates met Discord-notificaties

​Voorbeeld 3: websitecontent scrapen met e-mailnotificaties

​Volgende stappen

Inleiding

Vereisten

Het project opzetten

Een consolecommand maken

Taskscheduling met GitHub Actions

Notificaties

Praktische applicatievoorbeelden

Voorbeeld 1: uptime-monitoring van websites met Slack-alerts

Voorbeeld 2: cryptoportfolio-updates met Discord-notificaties

Voorbeeld 3: websitecontent scrapen met e-mailnotificaties

Volgende stappen