актуальзация документации

This commit is contained in:
bogdan zažigin 2022-12-17 21:15:48 +03:00
parent 3d74ec8949
commit acbad90b3b
4 changed files with 5 additions and 11 deletions

View file

@ -1,4 +1,4 @@
# Бот в Telegram для управления Личным кабинетом в ИТ-студии Зажигина
# Бот в Telegram для регистрации
Бот описан в [`src/bot/bot.ts`](../src/index.ts) на [TypeScript](https://www.typescriptlang.org/docs "Документация TypeScript") с помощью фреймворка [Grammy](https://grammy.dev/guide "Документация Grammy") над [Telegram Bot API](https://core.telegram.org/bots/api "Документация Telegram Bot API"). Предназначен для запуска в контейнере [Docker](https://docs.docker.com/reference "Документация Docker") через [NodeJS](https://nodejs.org/api/ "Документация NodeJS"), файл сборки можно видеть под названием [`src/dockerfile`](../src/dockerfile). Главный метод запуска проекта — через файл [Bash](https://www.gnu.org/software/bash/manual/bash.html "Документация Bash") скрипта [`start.sh`](../start.sh) от имени администратора.

View file

@ -1,9 +1,9 @@
## Настройки бота
Настройки бота расположены в директории [`src/bot/settings`](../src/bot/bot.ts) для Telegram Bot API и в файле переменных окружения [`env`](../env) для команды `source`. Файл переменных окружения имеет жизненно необходимые значения, их обязательно требуется указать.
Настройки бота расположены в директории [`src/bot/settings`](../src/bot/settings) для Telegram Bot API и в файле переменных окружения [`env.sh`](../env.sh) для команды `source`. Файл переменных окружения имеет жизненно необходимые значения, их обязательно требуется указать.
### [`env`](../env) — переменные окружения
### [`env.sh`](../env.sh) — переменные окружения
Для запуска бота требуется три константы в формате Bash:

View file

@ -1,8 +1,9 @@
## Запуск бота
Перед запуском требуется заполнить переменные окружения в [`env`](../env), руководство — [`settings.md`](./settings.md#env--переменные-окружения). С помощью команды `source` в [`start.sh`](../start.sh) на основе этих переменных в создаваемый контейнер от образа [`dockerfile`](../src/dockerfile) будет примонтированы файлы баз данных и передан токен.
Перед запуском требуется заполнить переменные окружения в [`env.sh`](../env.sh), руководство — [`settings.md`](./settings.md#envsh--переменные-окружения). С помощью команды `source` в [`start.sh`](../start.sh) на основе этих переменных в создаваемый контейнер от образа [`dockerfile`](../src/dockerfile) будет примонтированы файлы баз данных и передан токен.
Если все переменные указаны верно, можно запускать файл [`start.sh`](../start.sh) от имени администратора:
```bash
sudo bash start.sh
```

View file

@ -1,7 +0,0 @@
## Задачи
Далле составлен список задач для разработчиков бота:
- починить команду `/employ` — надо что бы по аргументам она приписывала вакансию пользователю, а она просто сообщает о доступных вакансиях;
- сделать пирамиды из `if … else` красивее;
- перенести все реплики в файл replies.json;