Skip to content

README-boiler.md

Latest commit

 

History

History
114 lines (79 loc) · 3.5 KB

README-boiler.md

File metadata and controls

114 lines (79 loc) · 3.5 KB

:APP_NAME:

Laravel-applicatie met Filament als admin-panel. Dit document beschrijft hoe je het project lokaal opzet op macOS met Laravel Herd en MySQL.

Vereisten

  • macOS
  • Laravel Herd (PHP 8.5 wordt meegeleverd)
  • MySQL (lokaal draaiend; bijvoorbeeld via DBngin)
  • Composer
  • Node.js (LTS) en npm

Controleer versies:

php -v    # 8.5.x
composer -v
node -v
mysql --version

Project opzetten

1. Repository clonen

git clone :REPO_URL:
cd :FOLDER:

Zet het project in een map die Herd kan serveren (bijv. ~/Projecten/:FOLDER: of je huidige projectmap).

2. Project in Herd aanmaken

  1. Open Laravel Herd (klik op het Herd-icoon in de menubalk).
  2. Ga naar Sites (of Add Site / Open).
  3. Kies Add Site
  4. Kies Link existing project en selecteer de map van dit project (bijv. ~/Projecten/:FOLDER:).
  5. Herd gebruikt de mapnaam als hostnaam: de site is bereikbaar op :APP_URL: (of http://[mapnaam].test).

Zorg dat de mapnaam geen spaties of vreemde tekens bevat, anders wordt de URL lastiger. Pas anders APP_URL in .env (stap 4) aan op de daadwerkelijke URL.

3. PHP-dependencies installeren

composer install

4. Omgevingsvariabelen

Kopieer het voorbeeldbestand en pas aan waar nodig:

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

Belangrijk voor lokale ontwikkeling:

  • APP_URL – Zet op :APP_URL: (Herd gebruikt de mapnaam als hostnaam).
  • DB_DATABASE – Database naam (standaard in .env.example: :DB_DATABASE:).
  • DB_USERNAME en DB_PASSWORD – Je MySQL-gebruiker en wachtwoord.

Externe services (Microsoft, SharePoint, Exact, VWE, etc.) zijn optioneel voor basisgebruik; je kunt die variabelen leeg laten of later invullen.

5. Migraties uitvoeren

php artisan migrate

Optioneel: seeders draaien als je startdata wilt (bijv. rollen, eerste gebruiker):

php artisan db:seed

6. Frontend-assets

npm install
npm run build

Tijdens ontwikkeling kun je in een aparte terminal npm run dev draaien voor hot reload.

7. URL controleren

Zorg dat APP_URL in .env exact overeenkomt met de URL die je in de browser gebruikt (bijv. :APP_URL:), inclusief http:// of https://.

8. Queue worker (lokaal)

De applicatie gebruikt de database als queue driver. Voor jobs (e-mails, imports, etc.) moet lokaal een worker draaien:

php artisan queue:listen

Overzicht nuttige commando’s

Commando Doel
php artisan migrate Migraties uitvoeren
php artisan db:seed Seeders uitvoeren
php artisan queue:listen Queue worker starten
npm run dev Vite dev server (hot reload)
npm run build Assets bouwen voor productie
php artisan shield:generate --all Shield permissies genereren (bijv. na het aanmaken van een nieuw model)

Edge cases en tips

  • Session/cache/queue gebruiken de database. Zorg dat migraties zijn gedraaid zodat de benodigde tabellen bestaan.
  • Filament heeft mogelijk een admin-gebruiker nodig; controleer of er een seeder is die een eerste admin aanmaakt, of maak handmatig een gebruiker met het juiste rol/recht.
  • Externe API’s (Exact, Microsoft, VWE, etc.): voor alleen de basis-app hoef je deze niet in te vullen. Vul ze wanneer je die integraties lokaal wilt testen.
  • Mapnaam vs. URL: als je de map hernoemt (bijv. naar :PROJECT_NAME:), verandert de Herd-URL mee; pas dan APP_URL aan.