OpenOverlay Standalone App

This is a template / example laravel app for the OpenOverlay package with websocket. You can use this to start with your overlay.

About OpenOverlay

OpenOverlay give you the possibility to easy connection your service with Twitch EventSub. Find out more here.

Installation

1. Clone OpenOverlay Standalone

2. Run composer install

   composer install

3. Copy .env.example to .env

   Add a custom passwort for DB_PASSWORD and DB_ROOT_PASSWORD

   cp .env.example .env

4. Start docker/sail

   ./vendor/bin/sail up

5. Generate APP Key

   ./vendor/bin/sail artisan key:generate

6. Migrate Database

   ./vendor/bin/sail artisan migrate

7. Create your account

   http://localhost/register

Services that this package use

• OpenOverlay
• Websockets
• Jetstream