Download the PHP package emincmg/convo-lite without Composer
On this page you can find all versions of the php package emincmg/convo-lite. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download emincmg/convo-lite
More information about emincmg/convo-lite
Files in emincmg/convo-lite
Package convo-lite
Short Description A lightweight conversation package for Laravel projects, facilitating smooth chat experiences.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package convo-lite
Convo Lite is a package that allows you to easily create and manage chat rooms in your Laravel application. This package enables your users to communicate with each other.
Installation
Include the package
You can include Convo Lite in your project using composer:
Migrate
Run the migrations to create the necessary database tables:
Publish the package's publishable files by running the following command:
This will publish the migration fies to your applications database/migrations folder, and config file to your applications config folder.
Configuration
Changing Default Model
You can change the default model for creating conversations between them through config/convo_lite.php
config file should be already published upon triggering command
This defaults to your applications default model, so you can change that or if you only change for this package change this field.
Localization
All translation files are published to lang/vendor/convo_lite folder and the language's abbreviation (e.g. /en for English).
Usage
To start using Convo Lite, you can add some basic routes and controller methods to manage conversations and messages. Here is an example usage:
Creating a conversation
Receiver could be both integer or array if multiple. If multiple receiver provided, conversation will be created between them.
This will return the conversation that has just been created;
To set a title for conversation, you could either;
or just create the conversation with title included.
both will return the same thing;
if multiple receivers are provided, response will be a collection of conversations that has been created.
Get a conversation
Add Participators
You can attach participators to an existing conversation by;
or you can send only the ID of the conversation;
you can add multiple participators as well;
``
Send Message
Send a message by facade (files are optional);
or you can pass conversation instance directly. ``
Get messages
Get by conversation model
or you can access its messages directly by conversation instance;
Broadcasting
Convo Lite supports Broadcasting via events and listeners.
Broadcasting Authorization
Events are broadcasted to the private channels of the users : user + id (eg user.1) . I recommend using Laravel Reverb on the backend along with Echo on the frontend for fast & secure implementation. Check out their Documentation here
Queues
Events are pushed to the queues specified in the config/convo_lite.php file
In order to process the events that got triggered, you should start your workers like this;
For broadcasting to work, default queue worker should be always started.
Licence
Convo Lite is open-source software licensed under the MIT license.
