Skip to content
This repository has been archived by the owner on Feb 4, 2024. It is now read-only.

Latest commit

 

History

History
218 lines (158 loc) · 7.29 KB

DOCUMENTATION.md

File metadata and controls

218 lines (158 loc) · 7.29 KB
Raw

API

This is where your Laravel application is stored.

Stack includes

  • Laravel (latest version)
  • Octane
  • PostgreSQL (and separate database for testing)
  • Redis
  • MailHog

Installation

The whole installation process is to create a shared network, build containers and initialize a new Laravel application.

Run the installation script in your terminal, and it will do it all automatically:

./install.sh

Also, it will install a Laravel app along with Octane package and Breeze API scaffolding.

Now you should be able to see it running in your browser at http://localhost:8000.

Usage

All docker commands are abstracted into Makefile instructions.

They are very simple and often just instead of the docker-compose command you need to write make in your terminal.

Of course, you can still use the docker-compose commands in the terminal, but you should remember that development and production environments rely on different docker-compose files.

Example:

# Make command
make up

# Full command
docker-compose -f docker-compose.dev.yml up -d

Because make commands are much easier to use than full docker-compose commands, I prefer and recommend using them, so free to explore them and edit according to your needs.

Start containers

# Make command
make up

# Full command
docker-compose -f docker-compose.dev.yml up -d

Now you can open http://localhost:8000 URL in your browser.

Stop containers

# Make command
make down

# Full command
docker-compose -f docker-compose.dev.yml down

Bash aliases

Also, there is a set of bash aliases which you can apply using the command:

source aliases.sh

Now to run any artisan command you can use:

artisan make:model Product

Logs

All laravel logs are forwarded to the docker log collector via the stderr channel.

See the latest logs, running the command:

docker-compose logs app

Storage

To use the public disk of the Laravel storage system you need to create a symlink.

The symlink should be relative to work properly inside the docker environment and outside it at the same time.

First, you need to install symfony/filesystem package which allows generating relative symlinks.

docker-compose -f docker-compose.dev.yml exec app composer require symfony/filesystem --dev

Then create the symlink using the command:

# Make command
make storage:link

# Raw command
docker-compose -f docker-compose.dev.yml exec app php artisan storage:link --relative

On production environment it will be created automatically.

Mailing

The MailHog service intercepts all sent emails by your application in development environment.

If you want to check how sent mails look, just go to http://localhost:8025.

Alternatives

The best alternative to this is the official Laravel Sail tool which is intended for development environment only.

Sail is automatically installed with all new Laravel applications.

If you do not have locally installed PHP or Composer but have docker, you can use the following commands:

# Install a new Laravel application
docker run --rm -it \
  -u "$(id -u)":"$(id -g)" \
  -v "$(pwd)":/var/www/html \
  -w /var/www/html \
  laravelsail/php81-composer:latest \
  composer create-project --prefer-dist laravel/laravel src
  
# Configure the Sail environment 
docker run --rm -it \
  -u "$(id -u)":"$(id -g)" \
  -v "$(pwd)":/var/www/html \
  -w /var/www/html/src \
  laravelsail/php81-composer:latest \
  php artisan sail:install

Also, there is an excellent project called Laradock that contains a full bunch of services.

To Do list

  • git dev pull script (when pulling existing app)

    • pull git branch
    • replace old .env file with a new one
    • build containers
    • composer install
    • generate api key
    • up containers (queue and octane should be restarted)
    • run migrations
    • seed database

  • git prod deploy script (can be called by ssh with secrets)

    • pull git branch
    • ensure env file is up-to-date (probably add git-ignored .env.prod.secrets (similar to docker swarm) to merge with .env.prod file)
    • build containers
    • composer install
    • generate api key
    • up containers (queue and octane should be restarted)
    • run migrations (--force)

  • add testing doc section

  • add xdebug doc section

  • add doc how to set up phpstorm

  • reduce image sizes (move to alpine versions)

  • add stubs system (to provide/replace additional services)

  • add stub for mysql

  • add stub for laravel-echo

  • add stub for s3 container, probably minio (for stateless app)

  • add stub for selenium (laravel dusk)

  • add stub to replace default queue runner with horizon (add horizon make commands)

  • add health checks to other containers

  • set up according to: https://phpunit.readthedocs.io/en/9.5/installation.html#recommended-php-configuration

  • also add possibility to disable xdebug in runtime

  • extract max_upload_size into env variable

  • add recommendation about logging with 'stack' driver (add 'stderr' to stack)

  • add info about laravel trusted proxy (REMOTE_ADDR)

  • add recommendations about authentication process (for API: no sanctum, no cookies, no sessions)

  • add info about laravel telescope issue due to TELESCOPE_DUMP_WATCHER during prod build

    • add commands to ignore list: ['package:discover', 'config:cache', 'route:cache', 'view:cache', 'event:cache', 'storage:link']

  • add info about local packages/modules (how to include for build)

  • add best practice about stateless app and using of storage and cookies

  • php-fpm

  • redis

    • add redis password
    • remove redis background saves
    • provide redis conf similar as nginx conf

  • simple git and docker-compose deployment

  • swarm deployment (separate docker-compose.swarm.yml)