README.md

Basement Chat Demo

Basement Chat demo integration with Laravel Breeze and Pusher

Table of Contents

• Introduction
• Installation
• Comparing which files were changed

Introduction

This is a demo implementation of the Basement Chat package with Laravel Braze and Soketi broadcast driver. Here's a live demo link using Railway, you should register first before trying it (no email verification required).

Installation

• Requirements:

  • git
  • php >= 8.1
  • node.js >= 18

• To install this demo repository, you can do the following steps:

  • Clone this repository git clone https://github.com/basement-chat/demo.git
  • Change your current working directory to demo
  • Install composer dependencies with composer install and install npm dependencies with npm install
  • Copy the environment file from .env.example to .env
  • Generate the key using php artisan key:generate
  • Configure your database connection in .env, the following are examples of some database configurations you can use:
    • SQLite
      • Make sure you have enabled the SQLite driver in your PHP
      • Then, just create a new empty file to database/database.sqlite path
    • MySQL
      • Make sure you have enabled the MySQL driver in your PHP
      • Create a new empty database from your MySQL
      • Change the DB_CONNECTION in .env to mysql
      • Configure other configurations that have DB_ prefix in .env, as an example:

        DB_CONNECTION=mysql
        DB_HOST=127.0.0.1
        DB_PORT=3306
        DB_DATABASE=basement_chat_demo
        DB_USERNAME=root
        DB_PASSWORD=password123
        

  • Run database migration php artisan migrate
  • Build assets npm run build
  • Start soketi with npx soketi start, and keep this terminal open
  • Finally, run the Laravel HTTP server php artisan serve and open http://127.0.0.1:8000 in your browser

Comparing which files were changed

To compare which files are changed in this repo when integrating the Basement Chat package, you can visit the following page.