Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/just-ai/alice-jaicf-template
Шаблонный проект навыка Алисы на Kotlin
https://github.com/just-ai/alice-jaicf-template
Last synced: about 6 hours ago
JSON representation
Шаблонный проект навыка Алисы на Kotlin
- Host: GitHub
- URL: https://github.com/just-ai/alice-jaicf-template
- Owner: just-ai
- Created: 2020-03-22T14:34:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-17T19:09:40.000Z (about 3 years ago)
- Last Synced: 2024-08-03T10:02:00.679Z (4 months ago)
- Language: Kotlin
- Size: 65.4 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-alice - alice-jaicf-template - Шаблонный проект на Kotlin (Примеры и навыки / Примеры)
README
# Шаблонный проект навыка Алисы на JAICF
Это готовый к использованию шаблон проекта навыка голосового ассистента Яндекс Алиса.
Написан с использованием [фреймворка JAICF](https://github.com/just-ai/jaicf-kotlin/tree/master/channels/yandex-alice) на языке [Kotlin](https://kotlinlang.org).
## Как использовать
Вы можете развернуть этот навык в облаке Heroku в один клик, а затем продолжить разработку и отладку на своем ПК.
### Развертывание на Heroku
2. Нажмите на кнопку ниже
Вебхук будет автоматически развернут в облаке Heroku, и вы получите рабочий сервер, который далее сможете обновлять (см ниже).
**При установке укажите ваш OAuth токен.**
### Тестирование
1. После развертывания вебхука нажмите на кнопку **View** и скопируйте URL. Это и есть ваш вебхук.
2. Создайте новый навык для Алисы в [Яндекс Диалогах](https://dialogs.yandex.ru/developer).
3. Укажите название навыка и URL вебхука, который вы скопировали (_остальные поля необязательны_).
4. Перейдите на вкладку _Тестирование_ - навык будет запущен автоматически.
### Локальная разработка и обновление сервера
#### Создание проекта
1. Установите [Heroku CLI](https://devcenter.heroku.com/articles/heroku-command-line).
2. Выполните следующие команды в терминале
```
heroku login
heroku git:clone -a <название вашего приложения на Heroku>
cd <название вашего приложения на Heroku>
git remote add origin https://github.com/just-ai/alice-jaicf-template
git pull origin master
```
3. Создайте новый проект в [IntelliJ IDEA](https://www.jetbrains.com/ru-ru/idea/download/) из исходных кодов (Project from Existing Sources), выберите Gradle из списка.
#### Разработка
Чтобы запустить вебхук локально, запустите `Webhook.kt`.
Сервер запускается на порту `8080`.
Чтобы разрабатывать навык, вам нужно получить публичный URL, который затем прописать в настройках вашего навыка в Яндекс Диалогах.
Для этого можно установить [ngrok](https://ngrok.com), а затем выполнить команду `ngrok http 8080` в терминале.
Таким образом все запросы от Алисы будут приходить на ваш локальный ПК, и вы сможете отлаживать сценарий навыка.
> Изучите [документацию JAICF](https://github.com/just-ai/jaicf-kotlin/tree/master/channels/yandex-alice), чтобы понимать, как разрабатывать навык для Алисы
#### Обновление сервера
Как только вы готовы обновить сервер, выполните следующие команды в терминале:
```
git add .
git commit -am "описание ваших изменений"
git push
```
Heroku автоматически соберет и обновит ваш сервер.
# Обратная связь
Если у вас возникли вопросы или проблемы, вы можете задать их в [Slack сообществе фреймворка JAICF](https://join.slack.com/t/jaicf/shared_invite/zt-clzasfyq-f4gv8hf3JHD4RmpMtrt0Aw) или [создать задачу](https://github.com/just-ai/alice-jaicf-template/issues) в этом репозитории.