{"id":19513444,"url":"https://github.com/escolalms/yepp-chat","last_synced_at":"2026-01-06T06:05:21.808Z","repository":{"id":226561814,"uuid":"767508372","full_name":"EscolaLMS/Yepp-Chat","owner":"EscolaLMS","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-03T13:02:52.000Z","size":482,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T08:30:23.749Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EscolaLMS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-05T12:23:40.000Z","updated_at":"2024-06-03T13:01:41.000Z","dependencies_parsed_at":"2024-11-10T23:30:19.594Z","dependency_job_id":"5dda1be7-2a56-4124-a1a1-f6df99f172ab","html_url":"https://github.com/EscolaLMS/Yepp-Chat","commit_stats":null,"previous_names":["escolalms/yepp-chat"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EscolaLMS%2FYepp-Chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EscolaLMS%2FYepp-Chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EscolaLMS%2FYepp-Chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EscolaLMS%2FYepp-Chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EscolaLMS","download_url":"https://codeload.github.com/EscolaLMS/Yepp-Chat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245431719,"owners_count":20614184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T23:30:01.185Z","updated_at":"2026-01-06T06:05:21.731Z","avatar_url":"https://github.com/EscolaLMS.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yepp-Chat\n\n[![swagger](https://img.shields.io/badge/documentation-swagger-green)](https://escolalms.github.io/Yepp-Chat/)\n[![codecov](https://codecov.io/gh/EscolaLMS/Yepp-Chat/branch/main/graph/badge.svg?token=NRAN4R8AGZ)](https://codecov.io/gh/EscolaLMS/Yepp-Chat)\n[![phpunit](https://github.com/EscolaLMS/Yepp-Chat/actions/workflows/test.yml/badge.svg)](https://github.com/EscolaLMS/Yepp-Chat/actions/workflows/test.yml)\n[![downloads](https://img.shields.io/packagist/dt/escolalms/Yepp-Chat)](https://packagist.org/packages/escolalms/Yepp-Chat)\n[![downloads](https://img.shields.io/packagist/v/escolalms/Yepp-Chat)](https://packagist.org/packages/escolalms/Yepp-Chat)\n[![downloads](https://img.shields.io/packagist/l/escolalms/Yepp-Chat)](https://packagist.org/packages/escolalms/Yepp-Chat)\n\n\n## What does it do\nThis package is used to communicate with the microservice responsible for chat on the Yepp platform.\n\nChat can be assigned to a lesson, after filling in the `assistant_id` parameter in the lesson.\nIf the lesson does not have a defined parameter, the chat will not be displayed.\n\n\n## Installing\n- `composer require escolalms/yepp-chat`\n- `php artisan migrate`\n- `php artisan db:seed --class=\"EscolaLms\\YeppChat\\Database\\Seeders\\YeppChatPermissionSeeder\"`\n\n## Configuration\nIn the configuration, you can:\n- `enabled` - Yepp chat integration is enabled/disabled\n- `auth.enabled` - Authorization in communication with microservice is enabled/disabled\n- `auth.key` - If `auth.enabled` takes the value true, an access key is required\n- `url` - Microservice URL\n\nYou can specify the parameter from the [config.php file](./src/config.php) or [system administration settings](./src/Providers/SettingsServiceProvider.php).\n\n```php\n[\n    'enabled' =\u003e env('YEPP_CHAT_ENABLED'),\n    'auth' =\u003e [\n        'enabled' =\u003e env('YEPP_CHAT_AUTH_ENABLED'),\n        'key' =\u003e env('YEPP_CHAT_AUTH_KEY'),\n    ],\n    'url' =\u003e env('YEPP_CHAT_URL', 'http://yepp-chat-ms-backend-service:3000'),\n];\n```\n\n\n## Endpoints\nAll the endpoints are defined in swagger\n[![swagger](https://img.shields.io/badge/documentation-swagger-green)](https://escolalms.github.io/Yepp-Chat/)\n\nTest details\n[![codecov](https://codecov.io/gh/EscolaLMS/Yepp-Chat/branch/main/graph/badge.svg?token=O91FHNKI6R)](https://codecov.io/gh/EscolaLMS/Yepp-Chat)\n![Tests PHPUnit in environments](https://github.com/EscolaLMS/Yepp-Chat/actions/workflows/test.yml/badge.svg)\n\n\n## Events\nThis package does not dispatch any events.\n\n## Permissions\nPermissions are defined in [seeder](database/seeders/YeppChatPermissionSeeder.php)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fescolalms%2Fyepp-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fescolalms%2Fyepp-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fescolalms%2Fyepp-chat/lists"}