https://github.com/ivokara/laravel-sail-installer

📥 Lightweight and simple Laravel + Sail project installer
https://github.com/ivokara/laravel-sail-installer

bash composer laravel laravel-sail

Last synced: 4 days ago
JSON representation

📥 Lightweight and simple Laravel + Sail project installer

• Host: GitHub
• URL: https://github.com/ivokara/laravel-sail-installer
• Owner: IvoKara
• Created: 2023-09-24T21:51:39.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-24T22:59:55.000Z (over 1 year ago)
• Last Synced: 2023-09-25T03:14:09.571Z (over 1 year ago)
• Topics: bash, composer, laravel, laravel-sail
• Language: Shell
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# laravel-sail-installer

📦 Revive the old `laravel new` syntax for project initialization

while taking advantage of Laravel's built-in containerizing solution, a.k.a **Laravel Sail**.

## Setup

To start using the command line tool you will need to clone this repository and run the `setup.sh` script:

```bash

git clone https://github.com/IvoKara/laravel-sail-installer.git

cd laravel-sail-installer

./setup.sh

```

This step copies the `laravel-sail-installer.sh` to your `~/.local/bin` directory 

under the name `laravel` making it accessible for the _current user only_.

If you prefer to make it accessible for the whole system you can manually move the 

installer script to `/usr/local/bin` (root privileges needed).

**After this you are ready to go!**

## Usage 

To create your conteinerized Laravel project with **Laravel Sail** simply type:

```bash

laravel new example-app

```

Of course, instead of "example-app" you can type whatever you want as an application name - just make sure 

it only contains alpha-numeric characters, dashes, and underscores. 

The Laravel application's directory will be created within the directory you execute the command from.

### Choose your sail service

Additionally you can specify which of the services should be included in your application.

As per [Laravel's documentation](https://laravel.com/docs/10.x#choosing-your-sail-services) currently available services are:

 * `mysql`

 * `pgsql`

 * `mariadb`

 * `redis`

 * `memcached`

 * `meilisearch`

 * `minio`

 * `selenium`

 * `mailpit`

If you do not specify any of them explicitly, а default configuration stack 

would include `mysql`, `redis`, `meilisearch`, `mailpit`, and `selenium`.

For instance, if your application just needs `mysql` and `redis`, then you should type the following:

```bash

laravel new example-app -w mysql,redis

```

or alternatively,

```bash

laravel new example-app --with="mysql,redis"

```

> Disclamer: you can pass the `-w` or `--with` option _before_ or _after_ the application's name.

You might also like to install a default [Devcontainer](https://laravel.com/docs/10.x/sail#using-devcontainers) 

by replacing the `new` keyword with `devcontainer`:

```bash

laravel devcontainer example-app --with="mysql,redis"

```