пока так
This commit is contained in:
parent
e4192f0bf0
commit
41b9830046
12 changed files with 18 additions and 18 deletions
|
@ -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).
|
5
documentation/readme.md
Normal file
5
documentation/readme.md
Normal file
|
@ -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).
|
|
@ -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) — предлагаемый набор прав администратора бота при добавлении в группу.
|
||||
|
||||
Эти настройки формируются согласно изменениям кода самого бота. Изменять их рекомендуются только разработчикам, внёсшим изменения.
|
|
@ -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"
|
||||
}
|
||||
}
|
|
@ -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
|
||||
CMD npm start
|
Loading…
Add table
Reference in a new issue