https://github.com/uselagoon/sailonlagoon

A library for quickly Lagoonizing Sail based Laravel apps
https://github.com/uselagoon/sailonlagoon

Last synced: about 2 months ago
JSON representation

A library for quickly Lagoonizing Sail based Laravel apps

• Host: GitHub
• URL: https://github.com/uselagoon/sailonlagoon
• Owner: uselagoon
• License: mit
• Created: 2024-04-02T18:30:14.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-08-20T09:48:32.000Z (5 months ago)
• Last Synced: 2024-10-30T23:49:52.925Z (2 months ago)
• Language: PHP
• Size: 50.8 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Sail:onLagoon

[![Latest Version on Packagist](https://img.shields.io/packagist/v/uselagoon/sailonlagoon.svg?style=flat-square)](https://packagist.org/packages/uselagoon/sailonlagoon)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/uselagoon/sailonlagoon/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/uselagoon/sailonlagoon/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/uselagoon/sailonlagoon/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/uselagoon/sailonlagoon/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/uselagoon/sailonlagoon.svg?style=flat-square)](https://packagist.org/packages/uselagoon/sailonlagoon)

Sail:onLagoon is a Laravel extension that simplifies the process of Lagoonizing Laravel sites 

that are already using Laravel Sail to generate their docker-compose setup.

This extension provides additional features and configurations tailored for Lagoon environments.

## Installation

The assumption is that you've already set up your Laravel development environment locally using [Sail](https://laravel.com/docs/11.x/sail). 

Once you have your Laravel site running locally, you can install `Sail on Lagoon` via composer:

```bash

composer require --dev uselagoon/sailonlagoon

```

Note that we install Sail:onLagoon as a dev dependency (with the `--dev` flag) as it simply creates and publishes

configuration files, therefore, the package itself isn't required at run time.

To use Sail:onLagoon, run the following Artisan command:

```bash

php artisan sail:onlagoon [--projectName=my-lagoon-project] [--no-interaction]

```

This will read your sail-generated docker-compose.yml file and attempt to generate the required files for a Lagoon installation.

You can, optionally, specify the name of your project and skip the interactive question.

Specifying `--no-interaction` will skip any interaction (including warnings) and Lagoonize the project.

## Requirements

There are very few requirements that aren't requirements for Sail directly, but they are:

- PHP >= 8.1

- Laravel >= 10

## Supported Services

Sail:onLagoon currently supports the following service types:

    MySQL

    PostgreSQL

    MariaDB

    Redis

    MeiliSearch

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Acknowledgements

Initial Laravel bootstrap code provided by [Workshop Orange](https://github.com/Workshop-Orange).

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.