Проект позволяет узнать актуальные курсы валют.
🔸 Выполнен на базе Telegram Mini App (Web App).
🔸 Курсы валют обновляются раз в час. (Поставщик курсов валют: https://fixer.io/)
🔸 Локализация: Английский, Русский
Проект состоит из трех основных сервисов, каждый из которых находитится в соответствующей папке:
- /backend - backend мини-приложения - отвечает за хранение и получение курсов валют от поставщика и реализует API для получения курсов фронтендом мини-приложения.
- /webapp - frontend мини-приложения
- /bot - backend бота: обрабатывает обновления (запросы пользователя) бота.
Папка config содержит файлы конфигурации сервисов.
Папка data используется для хранения базы данных redis на диске.
Для хранения курсов валют, полученных от поставщика используется Redis. В качестве веб-сервера для отдачи статических файлов мини-приложения и обратного прокси-сервера используется Nginx.
Сервисы запускаются в docker контейнерах. Docker - это платформа для создания, развертывания и управления контейнерами. Контейнеры позволяют упаковать приложение и все его зависимости в единое исполняемое окружение.
Управление docker контейнерами осуществляется с помощью Docker Compose. Docker Compose позволяет легко настроить и объекдинить сервисы вместе и запустить приложение одной командой. Файл конфигурации Docker Compose: docker-compose.yml (документация).
Для интеграции мини-приложения с Telegram нужно, чтобы оно размещалось на домене с ssl сертификатом. В данном руководстве не затрагиваются этапы получения сертификата. Вы можете использовать бесплатный сертификат от letsencrypt.
Убедитесь, что у вас установлено следующее:
*версия, используемая при разработке
-
Клонируйте репозиторий:
git clone https://github.com/kr-ilya/currency-converter.git
-
Перейдите в папку с проектом
cd currency-converter -
Настройка конфигурации
Основная конфигурация проекта задается путем редактирования файлов в папке config.
Содержимое папки:
- /nginx - содержит файл конфигурации nginx (reverse proxy)
- /redis - содержит файл конфигруации redis
- backend.env - файл конфигурации backend мини-приложения
- bot.env - файл конфигурации backend бота
Кроме этого в файле /webapp/src/js/app.js необходимо указать URL адрес API сервера (backend мини-приложения) (ссылка вида: https://example.com/api).
Параметры, обязательные к установке:
BOT_TOKEN - токен Telegram бота
WEBHOOK_BASE - URL адрес для webhook сервера, адрес должен иметь вид "scheme://host", например: https://example.com
WEBAPP_URL - URL адрес мини-приложения (ссылка на главную, совпадает с WEBHOOK_BASE)
Параметры, которые можно оставить по умолчанию
LOGGER_TYPE - тип логирования (prod/dev)
LISTEN_ADDRESS - адрес с портом webhook сервера бота.
При изменении также изменить порт в файле /config/nginx/nginx.conf. (в разделе upstream bot)
Параметры, обязательные к установке:
FIXER_ACCESS_TOKEN - API токен сервиса для получения курсов валют (fixer)
REDIS_PASS - пароль к базе redis (также указать в файле /redis/redis.conf, параметр requirepass)
BOT_TOKEN - токен Telegram бота
Параметры, которые можно оставить по умолчанию
LISTEN_ADDRESS - адрес с портом backend сервера бота.
При изменении также изменить порт в файле /config/nginx/nginx.conf. (в разделе upstream api)
LOGGER_TYPE - тип логирования (prod/dev)
REDIS_DB=0 - номер базы данных redis
REDIS_HOST - хост redis (соответствует названию сервиса из docker-compose.yml)
REDIS_PORT - порт redis (также указать в файле /redis/redis.conf, параметр port)
Файл конфигурации: /redis/redis.conf
Описание конфигурационного файла Redis
Требуется указать:
requirepass - пароль к базе redis
Файл конфигурации: /config/nginx.conf
Документация Nginx
В файле необходимо указать:
- server_name
- ssl_certificate
- ssl_certificate_key
- Запуск
docker compose up