Giter Club home page Giter Club logo

alice-jaicf-template's Introduction

Шаблонный проект навыка Алисы на JAICF

Это готовый к использованию шаблон проекта навыка голосового ассистента Яндекс Алиса. Написан с использованием фреймворка JAICF на языке Kotlin.

Как использовать

Вы можете развернуть этот навык в облаке Heroku в один клик, а затем продолжить разработку и отладку на своем ПК.

Развертывание на Heroku

  1. Скопируйте ваш OAuth токен
  1. Нажмите на кнопку ниже
Deploy

Вебхук будет автоматически развернут в облаке Heroku, и вы получите рабочий сервер, который далее сможете обновлять (см ниже).

При установке укажите ваш OAuth токен.

Тестирование

  1. После развертывания вебхука нажмите на кнопку View и скопируйте URL. Это и есть ваш вебхук.
  2. Создайте новый навык для Алисы в Яндекс Диалогах.
  3. Укажите название навыка и URL вебхука, который вы скопировали (остальные поля необязательны).
  4. Перейдите на вкладку Тестирование - навык будет запущен автоматически.

Локальная разработка и обновление сервера

Создание проекта

  1. Установите Heroku CLI.
  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
  1. Создайте новый проект в IntelliJ IDEA из исходных кодов (Project from Existing Sources), выберите Gradle из списка.

Разработка

Чтобы запустить вебхук локально, запустите Webhook.kt. Сервер запускается на порту 8080.

Чтобы разрабатывать навык, вам нужно получить публичный URL, который затем прописать в настройках вашего навыка в Яндекс Диалогах. Для этого можно установить ngrok, а затем выполнить команду ngrok http 8080 в терминале. Таким образом все запросы от Алисы будут приходить на ваш локальный ПК, и вы сможете отлаживать сценарий навыка.

Изучите документацию JAICF, чтобы понимать, как разрабатывать навык для Алисы

Обновление сервера

Как только вы готовы обновить сервер, выполните следующие команды в терминале:

git add .
git commit -am "описание ваших изменений"
git push

Heroku автоматически соберет и обновит ваш сервер.

Обратная связь

Если у вас возникли вопросы или проблемы, вы можете задать их в Slack сообществе фреймворка JAICF или создать задачу в этом репозитории.

alice-jaicf-template's People

Contributors

denire avatar morfeusys avatar veptechno avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

pa3pa6otka

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.