diff --git a/docs/readme.md b/docs/readme.md deleted file mode 100644 index 00ce24a..0000000 --- a/docs/readme.md +++ /dev/null @@ -1,5 +0,0 @@ -# Бот в Telegram для регистрации в организации - -Бот описан в [`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://t.me/emp_zaboal_bot) для [«Студии Зажигина»](https://site.zaboal.ru). diff --git a/documentation/readme.md b/documentation/readme.md new file mode 100644 index 0000000..6dbb6ec --- /dev/null +++ b/documentation/readme.md @@ -0,0 +1,5 @@ +# Бот в Telegram для регистрации в организации + +Бот описан в [`src/bot/bot.ts`](../source/bot-telegram_register/bot.ts) на TypeScript с помощью фреймворка Grammy над Telegram Bot API. Предназначен для запуска в контейнере Docker через NodeJS, файл сборки образа можно видеть под названием [`src/dockerfile`](../source/dockerfile). Главный метод запуска проекта — через файл Bash скрипта [`start.sh`](../source/start.sh). Процедура запуска изложена подробнее в [`docs/start.md`](start.md), вся документация в этой же директории. + +Официально запускается от имени [@emp_zaboal_bot](https://t.me/emp_zaboal_bot) для [«Студии Зажигина»](https://site.zaboal.ru). diff --git a/docs/settings.md b/documentation/settings.md similarity index 62% rename from docs/settings.md rename to documentation/settings.md index 4774cd7..a8fb132 100644 --- a/docs/settings.md +++ b/documentation/settings.md @@ -3,22 +3,22 @@ Настройки бота расположены в директории [`src/bot/settings`](../src/bot/settings) для Telegram Bot API и в файле переменных среды [`environment.sh`](../environment.sh) для команды `source`. Файл переменных окружения имеет жизненно необходимые значения, их обязательно требуется указать. -### [`environment.sh`](../environment.sh) — переменные среды +### [`environment.sh`](../source/environment.sh) — переменные среды Для запуска бота требуется три константы в формате Bash: * `BOT_TOKEN` — токен бота, получаемый от [BotFather](https://t.me/BotFather); -* `BOT_DB_PATH` — путь к базе данных SQLite бота на хосте, с данными об идентификаторах пользователя Телеграм людей зарегистрированных в организации (схема базы данных описана [здесь](/home/zaboal/work/templates/database-schemas/sql/organizational_structure/organizational_structure.sql)); -* `ORG_BD_PATH` — путь к базе данных SQLite орагнизации, с данными об подразделениях, рабочих и т.д. (схема базы данных описана [здесь](/home/zaboal/work/templates/database-schemas/sql/organizational_structure/organizational_structure.sql)). +* `BOT_DB_PATH` — путь к базе данных SQLite бота на хосте, с данными об идентификаторах пользователя Телеграм людей зарегистрированных в организации; +* `ORG_BD_PATH` — путь к базе данных SQLite орагнизации, с данными об подразделениях, рабочих и т.д. -Данные будут переданы в контейнер Docker в процессе Bash скрипта запуска проекта [`start.sh`](../start.sh). По путям к базам данных на хосте в контейнер будут примонтированы соответствующие файлы SQLite под программными названиями. +Данные будут переданы в контейнер Docker в процессе Bash скрипта запуска проекта [`start.sh`](../source/start.sh). По путям к базам данных на хосте в контейнер будут примонтированы соответствующие файлы SQLite под программными названиями. -### [`src/bot/settings`](../src/bot/bot.ts) — переменные для Telegram Bot API +### [`settings/*.json`](../source/bot-telegram_register/settings) — переменные для Telegram Bot API -При запуске бот передаст Telegram Bot API файлы конфигурации в формате json из директории [`settings`](../src/bot/settings/): +При запуске бот передаст Telegram Bot API файлы конфигурации в формате json из директории [`settings`](../source/bot-telegram_register/settings/): -* [`commands.json`](../src/bot/settings/commands.json) — список команд и их описаний бота; +* [`commands.json`](../source/bot-telegram_register/settings/commands.json) — список команд и их описаний бота; * [`default_administrator_rights.json`](../src/bot/settings/default_administrator_rights.json) — предлагаемый набор прав администратора бота при добавлении в группу. Эти настройки формируются согласно изменениям кода самого бота. Изменять их рекомендуются только разработчикам, внёсшим изменения. \ No newline at end of file diff --git a/docs/start.md b/documentation/start.md similarity index 100% rename from docs/start.md rename to documentation/start.md diff --git a/src/bot/bot.ts b/source/bot-telegram_register/bot.ts similarity index 100% rename from src/bot/bot.ts rename to source/bot-telegram_register/bot.ts diff --git a/src/package.json b/source/bot-telegram_register/package.json similarity index 81% rename from src/package.json rename to source/bot-telegram_register/package.json index bb319ad..9025ed4 100644 --- a/src/package.json +++ b/source/bot-telegram_register/package.json @@ -1,12 +1,12 @@ { - "scripts": { - "start": "ts-node bot/bot.ts" - }, "dependencies": { "grammy": "latest", "sqlite3": "latest" }, "devDependencies": { "ts-node": "latest" + }, + "scripts": { + "start": "ts-node bot.ts" } } \ No newline at end of file diff --git a/src/bot/settings/commands.json b/source/bot-telegram_register/settings/commands.json similarity index 100% rename from src/bot/settings/commands.json rename to source/bot-telegram_register/settings/commands.json diff --git a/src/bot/settings/default_administrator_rights.json b/source/bot-telegram_register/settings/default_administrator_rights.json similarity index 100% rename from src/bot/settings/default_administrator_rights.json rename to source/bot-telegram_register/settings/default_administrator_rights.json diff --git a/src/bot/tsconfig.json b/source/bot-telegram_register/tsconfig.json similarity index 100% rename from src/bot/tsconfig.json rename to source/bot-telegram_register/tsconfig.json diff --git a/dockerfile b/source/dockerfile similarity index 83% rename from dockerfile rename to source/dockerfile index bca48bc..25b1899 100644 --- a/dockerfile +++ b/source/dockerfile @@ -6,11 +6,11 @@ WORKDIR /usr/src/app # Установка зависимостей -COPY src/package.json . +COPY bot-telegram_register/package.json . RUN npm install # Добавление оставшихся файлов проекта -COPY src . +COPY bot-telegram_register . # Объявление переменных окружения @@ -18,4 +18,4 @@ ARG BOT_TOKEN # Запуск контейнера -CMD npm run start \ No newline at end of file +CMD npm start \ No newline at end of file diff --git a/environment.sh b/source/environment.sh similarity index 100% rename from environment.sh rename to source/environment.sh diff --git a/start.sh b/source/start.sh similarity index 100% rename from start.sh rename to source/start.sh