From acbad90b3b660182ddff99228de4d367f11162b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=97=D0=B0=D0=B6=D0=B8=D0=B3=D0=B8=D0=BD=20=D0=91=D0=BE?= =?UTF-8?q?=D0=B3=D0=B4=D0=B0=D0=BD=20=D0=90=D0=BB=D0=B5=D0=BA=D1=81=D0=B5?= =?UTF-8?q?=D0=B5=D0=B2=D0=B8=D1=87?= Date: Sat, 17 Dec 2022 21:15:48 +0300 Subject: [PATCH] =?UTF-8?q?=D0=B0=D0=BA=D1=82=D1=83=D0=B0=D0=BB=D1=8C?= =?UTF-8?q?=D0=B7=D0=B0=D1=86=D0=B8=D1=8F=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC?= =?UTF-8?q?=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/readme.md | 2 +- docs/settings.md | 4 ++-- docs/start.md | 3 ++- docs/todo.md | 7 ------- 4 files changed, 5 insertions(+), 11 deletions(-) delete mode 100644 docs/todo.md diff --git a/docs/readme.md b/docs/readme.md index f792488..189d8fe 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -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) от имени администратора. diff --git a/docs/settings.md b/docs/settings.md index 809e2a6..ae7185f 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -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: diff --git a/docs/start.md b/docs/start.md index da13730..c58e6d9 100644 --- a/docs/start.md +++ b/docs/start.md @@ -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 ``` \ No newline at end of file diff --git a/docs/todo.md b/docs/todo.md deleted file mode 100644 index 7aa7333..0000000 --- a/docs/todo.md +++ /dev/null @@ -1,7 +0,0 @@ -## Задачи - -Далле составлен список задач для разработчиков бота: - -- починить команду `/employ` — надо что бы по аргументам она приписывала вакансию пользователю, а она просто сообщает о доступных вакансиях; -- сделать пирамиды из `if … else` красивее; -- перенести все реплики в файл replies.json; \ No newline at end of file