Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/escolalms/yepp-chat

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/escolalms/yepp-chat
Owner: EscolaLMS
License: mit
Created: 2024-03-05T12:23:40.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-06-03T13:02:52.000Z (5 months ago)
Last Synced: 2024-09-14T12:11:00.931Z (2 months ago)
Language: PHP
Size: 471 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Yepp-Chat

[![swagger](https://img.shields.io/badge/documentation-swagger-green)](https://escolalms.github.io/Yepp-Chat/)

[![codecov](https://codecov.io/gh/EscolaLMS/Yepp-Chat/branch/main/graph/badge.svg?token=NRAN4R8AGZ)](https://codecov.io/gh/EscolaLMS/Yepp-Chat)

[![phpunit](https://github.com/EscolaLMS/Yepp-Chat/actions/workflows/test.yml/badge.svg)](https://github.com/EscolaLMS/Yepp-Chat/actions/workflows/test.yml)

[![downloads](https://img.shields.io/packagist/dt/escolalms/Yepp-Chat)](https://packagist.org/packages/escolalms/Yepp-Chat)

[![downloads](https://img.shields.io/packagist/v/escolalms/Yepp-Chat)](https://packagist.org/packages/escolalms/Yepp-Chat)

[![downloads](https://img.shields.io/packagist/l/escolalms/Yepp-Chat)](https://packagist.org/packages/escolalms/Yepp-Chat)

## 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](./src/config.php) or [system administration settings](./src/Providers/SettingsServiceProvider.php).

```php

[

    '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

[![swagger](https://img.shields.io/badge/documentation-swagger-green)](https://escolalms.github.io/Yepp-Chat/)

Test details

[![codecov](https://codecov.io/gh/EscolaLMS/Yepp-Chat/branch/main/graph/badge.svg?token=O91FHNKI6R)](https://codecov.io/gh/EscolaLMS/Yepp-Chat)

![Tests PHPUnit in environments](https://github.com/EscolaLMS/Yepp-Chat/actions/workflows/test.yml/badge.svg)

## Events

This package does not dispatch any events.

## Permissions

Permissions are defined in [seeder](database/seeders/YeppChatPermissionSeeder.php)