README.md

SmartApp Backend

Это backend на SmartApp Code для небольшого Canvas App: Todo (добавление, выполнение и удаление задач. См. видео). Для работы необходимо сделать fork-проекта в свой git-репозиторий, создать новый проект в SmartApp Studio и подключить к нему созданный git-репозиторий. После этого можно взять токен и связать backend с frontend.

Создание проекта в "SmartApp Code":

1. Делаем fork проекта в свой репозиторий;
2. Идём на страницу SmartApp Code (ссылка);
3. Нажимаем "Создать проект";
4. Указываем "Имя";
5. Переходим в раздел "Размещение";
6. Указываем внешний репозиторий;
7. Указываем ссылку до созданного репозитория, бранч main;
8. Указываем доступ: собственная учётная запись, логин и пароль от учётной записи в github;
9. Нажимаем "Создать";
10. Нажимаем "Создать смартапп";
11. Переходим в раздел разработка.
12. Нажимаем "Сценарии";
13. Нажимаем "Собрать";
14. Нажимаем "Публикации";
15. Нажимаем "Получить вебхук" (URL на Webhook копируется в буфере обмена).
16. В директории проекта в SmatApp Code выбрать "Настройки проекта"-> "Дополнительно". Активировать пункт "Отправлять команду /start на запуск голосом".
17. В директории проекта в SmatApp Code выбрать "Редактор"-> "Сущности". Далее перейти на вкладку "Системные", в выпадающем списке найти и активировать сущность "duckling.number"

Заводим проект в "SmartApp Studio":

1. Идём на страницу SmartApp Studio (ссылка);
2. Нажимаем "Создать смартапп";
3. Указываем "Имя";
4. Переключаем "Выбор типа смартапа" на "Canvas App";
5. Переключаем "Выбор инструмента" на "Есть готовое приложение";
6. Указываем URL на "Webhook" (полученный в "SmartApp Code");
7. Указываем URL на "Frontend Endpoint" (url страницы, где будет размещаться клиентская часть вашего приложения. Для локального запуска не используется, можете указать любой);
8. Нажимаем "Создать смартап".

Коллекции в "Postman":

1. Идём на страницу Postman (ссылка), регистрируем аккаунт;
2. В новом Workspace нажимаем "Import";
3. Загружаем файлы из папки "postman" (collection и demo_env) директории проекта todo-canvas-app-backend;
4. В правой верхней части экрана, рядом с полем demo_env, нажимаем на кнопку с иконкой глаза;
5. Выбираем "Edit";
6. Задаем initial_value для поля webhook (URL, полученный в "SmartApp Code");
7. Задаем initial_value для поля name_scenario (имя для запуска сценария)