https://github.com/open-southeners/sidecar-local

An extension of Laravel Sidecar project to be able to use it locally with Docker
https://github.com/open-southeners/sidecar-local

lambda-functions laravel-package laravel-sidecar local-development php testing-lambda-functions

Last synced: 12 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/open-southeners/sidecar-local
• Owner: open-southeners
• License: mit
• Created: 2023-10-18T10:38:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-11T14:36:59.000Z (over 1 year ago)
• Last Synced: 2025-05-28T10:11:32.975Z (about 1 year ago)
• Topics: lambda-functions, laravel-package, laravel-sidecar, local-development, php, testing-lambda-functions
• Language: PHP
• Homepage:
• Size: 122 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
Laravel Sidecar Local [![required php version](https://img.shields.io/packagist/php-v/open-southeners/sidecar-local)](https://www.php.net/supported-versions.php) [![codecov](https://codecov.io/gh/open-southeners/sidecar-local/branch/main/graph/badge.svg?token=JKIjarQfLa)](https://codecov.io/gh/open-southeners/sidecar-local) [![Edit on VSCode online](https://img.shields.io/badge/vscode-edit%20online-blue?logo=visualstudiocode)](https://vscode.dev/github/open-southeners/sidecar-local)

===

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

## Getting started

```bash

composer require open-southeners/sidecar-local

```

### Setting up

Publish config file with the following command:

```bash

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:

```bash

php artisan sidecar:local --run

```

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

```bash

php artisan sidecar:local --stop

```

## Partners

[![skore logo](https://github.com/open-southeners/partners/raw/main/logos/skore_logo.png)](https://getskore.com)

## License

This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).