README

What does it do

This package is used to communicate with the microservice responsible for chat on the Yepp platform.

Chat can be assigned to a lesson, after filling in the assistant_id parameter in the lesson. If the lesson does not have a defined parameter, the chat will not be displayed.

Installing

• composer require escolalms/yepp-chat
• php artisan migrate
• php artisan db:seed --class="EscolaLms\YeppChat\Database\Seeders\YeppChatPermissionSeeder"

Configuration

In the configuration, you can:

• enabled - Yepp chat integration is enabled/disabled
• auth.enabled - Authorization in communication with microservice is enabled/disabled
• auth.key - If auth.enabled takes the value true, an access key is required
• url - Microservice URL

You can specify the parameter from the config.php file or system administration settings.

[
    'enabled' => env('YEPP_CHAT_ENABLED'),
    'auth' => [
        'enabled' => env('YEPP_CHAT_AUTH_ENABLED'),
        'key' => env('YEPP_CHAT_AUTH_KEY'),
    ],
    'url' => env('YEPP_CHAT_URL', 'http://yepp-chat-ms-backend-service:3000'),
];

Endpoints

All the endpoints are defined in swagger

Test details

Events

This package does not dispatch any events.

Permissions

Permissions are defined in seeder