laravel with sail

basics

• install docker compose with specific commands of the system it is used on
• install composer locally: wget https://getcomposer.org/installer
• install sail (docker environment for laravel): curl -s “https://laravel.build/project-name?with=mysql,selenium,mailhog,redis” | bash
• check for local and forward ports for docker in file .env and add available ports
  • (APP_PORT=38080
    FORWARD_DB_PORT=33306
    FORWARD_REDIS_PORT=36379
    FORWARD_MEILISEARCH_PORT=37700
    FORWARD_MAILHOG_PORT=31025
    FORWARD_MAILHOG_DASHBOARD_PORT=38025)
• start docker environment in background: ./vendor/bin/sail up -d
• new app may be accessed via http://localhost:port
• stop the server again: sail down

command alias: alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'

Proxy

in App\Http\Middleware\TrustProxies the protected variable $proxies must be changed to:

protected $proxies = [‘127.0.0.1’];

git

• initialize git repo in current folder: git init
• git remote add laravel ssh://git@olkn.myvnc.com/home/git/repo-laravel-dev.git
• .gitignore to list all files that should not be included in git repo (sail automatically generates the file)
• add files to staging: git add -A
• commit changes to repo: git commit -m “comment“
• push changes to remote repo: git push laravel

Laravel Breeze

• install the breeze packages to start of with: sail composer require laravel/breeze –dev
• install blade frontend with breeze: sail php artisan breeze:install blade (complete template including user authentication)
• compile CSS and refresh browser: sail npm run dev
• migrate data base: sail php artisan migrate

Models/Migrations/Controllers

sail php artisan make:model -mrc

Models

interface to the tables in the data base; eloquent model

app/Models/.php

Migrations

create and modify tables in data base

database/migrations/_create__tables.php

Controllers

processing requests towards application and returning responses

app/Http/Controller/Controller.php

deployment

steps on server

• git clone serverAddressAndFolder
• point web server root to folder public
• modify/update .env file
• php artisan key:generate – generates APP_KEY in .env file
• php artisan migrate – migrate the data base schema
• php artisan db:seed – if you want to seed your data base
• php artisan down – shut website down for maintenance
• git pull – pull latest git files to server
• composer install – to check for any necessary updates from composer.lock file
• php artisan migrate – migrate the data base schema
• systemctl restart apache2 – to kill any php session
• php artisan queue:restart – to enable and restart any queues
• php artisan cache:clear – clear cache
• php artisan up – start laravel website again

.env

php artisan config:cache enable caching of env in production environment


APP_DEBUG = true for development only
APP_EMV=staging for development server
APP_URL=http://localhost - may be different for dev server
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=


maintenance mode

php artisan down #enable maintenance

php artisan up #disable maintenance

folder structure

• app – core code
  • Broadcasting – broadcast channel classes
  • Console – custom artisan commands
  • Events – event classes
  • Exceptions – app exceptions handlers
  • Http – controllers and middleware
  • Jobs – queueable jobs
  • Listeners – classes that handle events
  • Mail – email classes
  • Models – eloquent model classes
  • Notifications – transactional notifications
  • Policies – authorization policy classes
  • Providers – service provider classes
  • Rules – custom validation rules
• bootstrap – app.php to bootstrap the framework
• config
• database – database migrations, model factories and seeds
• lang – language files
• public – index.php as entry point
• resources – all views and raw assets (CSS, JavaScript)
• routes – all route definitions
• storage – logs, compiled Blade templates, session files, file caches
• tests – automated tests
• vendor – composer dependencies

Request Lifecycle

some useful commands

• sail shell (access a shel within the docker container)
• sail root-shell
• ./vendor/bin/sail php –version
• ./vendor/bin/sail artisan –version
• ./vendor/bin/sail composer –version
• ./vendor/bin/sail npm –version

speed up

• php artisan config:cache
• php artisan route:cache
• php artisan optimize –force

clean up

• php artisan config:clear
• php artisan route:clear
• php artisan view:clear

Laravel Sail Docker Environment

vendor/laravel/sail/runtimes/8.2/Dockerfile

FROM ubuntu:22.04

ENTRYPOINT ["start-container"]


./docker-compose.yml

# For more information: https://laravel.com/docs/sail
version: '3'
services:
laravel.test:
build:
context: ./vendor/laravel/sail/runtimes/8.1
dockerfile: Dockerfile
args:
WWWGROUP: '${WWWGROUP}'
image: sail-8.1/app
extra_hosts:
- 'host.docker.internal:host-gateway'
ports:
- '${APP_PORT:-80}:80'
- '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
environment:
WWWUSER: '${WWWUSER}'
LARAVEL_SAIL: 1
XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
volumes:
- '.:/var/www/html'
networks:
- sail
depends_on:
- mysql
- mailhog
- selenium
mysql:
image: 'mysql/mysql-server:8.0'
ports:
- '${FORWARD_DB_PORT:-3306}:3306'
environment:
MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
MYSQL_ROOT_HOST: "%"
MYSQL_DATABASE: '${DB_DATABASE}'
MYSQL_USER: '${DB_USERNAME}'
MYSQL_PASSWORD: '${DB_PASSWORD}'
MYSQL_ALLOW_EMPTY_PASSWORD: 1
volumes:
- 'sail-mysql:/var/lib/mysql'
- './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
networks:
- sail
healthcheck:
test: ["CMD", "mysqladmin", "ping", "-p${DB_PASSWORD}"]
retries: 3
timeout: 5s
mailhog:
image: 'mailhog/mailhog:latest'
ports:
- '${FORWARD_MAILHOG_PORT:-1025}:1025'
- '${FORWARD_MAILHOG_DASHBOARD_PORT:-8025}:8025'
networks:
- sail
selenium:
image: 'selenium/standalone-chrome'
extra_hosts:
- 'host.docker.internal:host-gateway'
volumes:
- '/dev/shm:/dev/shm'
networks:
- sail
networks:
sail:
driver: bridge
volumes:
sail-mysql:
driver: local

VSCode

Export extensions via local shell command (STRG+SHIFT+P terminal local):

code --list-extensions | sed -e 's/^/code --install-extension /' > my_vscode_extensions.sh

Import extensions via:

bash my_vscode_extensions.sh