zenoware/sailstream

Laravel + Sail + Jetstream. Spin something quickly.

v1.0.1 2024-02-21 11:20 UTC

Requires

• php: ^8.3
• guzzlehttp/guzzle: ^7.2
• inertiajs/inertia-laravel: ^0.6.8
• laravel/framework: ^10.10
• laravel/jetstream: ^4.2
• laravel/sanctum: ^3.3
• laravel/telescope: ^4.17
• laravel/tinker: ^2.8
• tightenco/ziggy: ^1.0

Requires (Dev)

• fakerphp/faker: ^1.9.1
• laravel/pint: ^1.0
• laravel/sail: ^1.27
• mockery/mockery: ^1.4.4
• nunomaduro/collision: ^7.0
• phpunit/phpunit: ^10.1
• spatie/laravel-ignition: ^2.0

MIT

• framework
• laravel
• docker
• sail
• jetstream

README

Overview

Clone this starter project if you're in a hurry to spin up a Laravel project with Sail + Jetstream for the UI scaffold.

I created this repo because it's onerous to keep on scaffolding the same things over and over when I'm trying to do a demo or starter project.

Requirements

A working understanding of how Laravel, Sail, and Jetstream work together.

It has all Sail services enabled by default (except for MariaDB and Postgres). PHPMyAdmin was added on for easy DB viewing. Take care of possible port collisions yourself.

Nuances

• Default MySQL DB host port has been changed to 3307. Change FORWARD_DB_PORT if needed.
• AWS-prefix env var defaults have been changed to Minio.

Installation

Clone

composer global require zenoware/sailstream-installer

sailstream new

or

composer create-project zenoware/sailstream --prefer-dist

Set environment variables

cp .env.example .env

Install composer dependencies

composer install

Run

./vendor/bin/sail up

Migrate

./vendor/bin/sail artisan migrate

Build front-end

./vendor/bin/sail npm install
./vendor/bin/sail npm run dev

Symlink storage

./vendor/bin/sail artisan storage:link

(Optional) SSH into the app container

./vendor/bin/sail shell

Quick links

• Laravel
• Telescope
• PHPMyAdmin
• Minio (don't forget to add a local bucket with R/W permissions)
• Mailpit