Skip to content

Latest commit

 

History

History
126 lines (88 loc) · 2.81 KB

README.md

File metadata and controls

126 lines (88 loc) · 2.81 KB
Raw

A powerful dashboard for Soketi

ScreenShots

Dashboard for All App

dashboard

Single app configuration

app

Credentails Page

credentails

Project Overview

This project is a powerful dashboard for Soketi. It is built with Laravel and Livewire. One step complete solution for your soketi server with build in features like:

  • App Mangement
  • Webhook Management
  • App configuration
  • Database Driver
  • Debugger

Table of Contents

Installation

Follow these steps to set up the project locally:

  1. Clone the repository:
git clone https://github.com/imerfanahmed/dash-soketi.git
  1. Navigate to the project directory:
cd dash-soketi
  1. Install dependencies:
composer install
npm install
  1. Copy the environment file:
cp .env.example .env
  1. Generate the application key:
php artisan key:generate

  1. Configure the database in the .env file.

  2. Run migrations and seed the database:

php artisan migrate --seed
  1. Install Soketi Server Globally
    1. The following example works for Ubuntu. For other distributions, consider using the equivalents.
    apt install -y git python3 gcc build-essential
    1. Node.js LTS (14.x, 16.x, so on) is required due to uWebSockets.js build limitations. You can install it using the following commands:
    npm install -g @soketi/soketi

Getting Started

First Start the soketi server within the folder as .env consists of the configuration for soketi

soketi start

To start the Dashboard server, run the following command:

php artisan serve

Visit http://localhost:8000 in your browser to view the application.

NOTE: If you find difficulties and want me to setup for you, you can directly email me at erfan.siam98@gmail.com

Testing

To run tests, use the following command:

php artisan test

The application uses PHPUnit for testing.

Contributing

If you would like to contribute to the project, please follow the contribution guidelines.

License

This project is open-source and available under the MIT License. Feel free to use, modify, and distribute the code as needed.

Happy coding!