open-southeners/sidecar-local

An extension of Laravel Sidecar project to be able to use it locally with Docker

1.3.1 2024-05-24 11:55 UTC

Requires

• php: ^8.1
• hammerstone/sidecar: ~0.6
• illuminate/console: ^10.0 || ^11.0
• illuminate/filesystem: ^10.0 || ^11.0
• illuminate/support: ^10.0 || ^11.0
• symfony/yaml: ^6.3 || ^7.0

Requires (Dev)

• larastan/larastan: ^2.0
• orchestra/testbench: ^8.0 || ^9.0
• phpstan/phpstan: ^1.0
• phpunit/phpunit: ^10.0

MIT

• Ruben Robles

• testing
• laravel
• docker
• local-development
• open-southeners
• laravel-sidecar
• aws-lambda-php
• lambda-php

README

An extension of Laravel Sidecar project to be able to use it locally with Docker.

Getting started

composer require open-southeners/sidecar-local

Setting up

Publish config file with the following command:

php artisan vendor:publish --provider="OpenSoutheners\\SidecarLocal\\ServiceProvider"

Then don't forget to set your sidecar.env config option to local and the sidecar.functions with the ones you want to test locally to make this work.

Run the following command to publish docker-compose.yml file into resources/sidecar folder with --run option to run Docker with all services locally:

php artisan sidecar:local --run

To stop the services you can just run the same but with --stop option:

php artisan sidecar:local --stop

Partners

License

This package is open-sourced software licensed under the MIT license.