отредактировал документацию и убрал dev обработчик

This commit is contained in:
bogdan zažigin 2022-12-17 23:45:43 +03:00
parent dc4e0470ba
commit 0f08134e45
4 changed files with 5 additions and 23 deletions

View file

@ -1,5 +1,5 @@
# Бот в 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) от имени администратора (руководство по запуску описано в [`docs/start.md`](start.md).). Бот описан в [`src/bot/bot.ts`](../src/index.ts) на TypeScript с помощью фреймворка Grammy над Telegram Bot API. Предназначен для запуска в контейнере Docker через NodeJS, файл сборки можно видеть под названием [`src/dockerfile`](../src/dockerfile). Главный метод запуска проекта — через файл Bash скрипта [`start.sh`](../start.sh), руководство по запуску описано в [`docs/start.md`](start.md).).
Официально запускается от имени [@emp_zaboal_bot](https://emp_zaboal_bot.t.me) и администрируется [Богданом](https://zaboal.t.me) для [«Студии Зажигина»](https://site.zaboal.ru). Официально запускается от имени [@emp_zaboal_bot](https://emp_zaboal_bot.t.me) для [«Студии Зажигина»](https://site.zaboal.ru).

View file

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

View file

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

View file

@ -1,6 +1,4 @@
/* // Главный файл исходного кода бота
Главный файл исходного кода бота
*/
// Подключение зависимостей // Подключение зависимостей
import { Bot } from "grammy"; import { Bot } from "grammy";
@ -83,22 +81,6 @@ bot.command("register", ctx => { // Команда регистрац
}); });
}); });
bot.command("sqlite", ctx => { // Команда работы с базами данных
database.get(`${ctx.match}`, (error, result) => {
if (error == null) {
ctx.reply(
"`" + ((result == undefined) ? "Ничего не найдено" : JSON.stringify(result)) + "`",
{ parse_mode: "MarkdownV2" }
);
} else {
ctx.reply(
"`" + JSON.stringify(error) + "`",
{ parse_mode: "MarkdownV2" }
);
}
});
})
// Запуск бота // Запуск бота
bot.start({ bot.start({