Skip to content

r-mol/RoomTgBot

Repository files navigation

📚 Project Description

У нас были разные бытовые проблемы (такие как: кто должен принести воду, отчет по тому кто что купил и тд) с соседями по комнате. Из -за этого мы решили телеграмм бота на Golang 🙃. Теперь мы оптимизировали данные процессы в нашей комнате. А также мы начали соревноваться, кто принес больше воды!!!

🎬 Demo

Screenshot

📝 Usage

✏️ Features

Feature Supported
Отмечать кто принес воду
Отмечать кто прибрался в комнате
Отправлять/получать отчет по покупкам в магазине
Отправлять/получать новости для комнаты
Получать статистику по приносу воды
Настройка получения уведомлений от бота

📝 Getting started

Мы рекомендуем использовать docker, как наиболее простое и независимое от платформы решение.

🎚️ Setup credits

  • Откройте папку env.
  • *.env.tpl файлы это файлы шаблоны с необходимыми параметрами. скопируйте все <file>.env.tpl в <file>.env и введите секреты для приложения (телеграм токен, пароль для баз данных). В сумме всего 6 строк. Поделены на файлы для вашей безопасности :)

🐳 Using Docker

  • docker-compose up для запуска основного приложения.
  • Ну и все :^)

⚙️ Configure manually

  1. go build -o bot-exe ./cmd - компилирует бота
  2. source ./env/* добавляет переменные из env в шелл.
  3. ./bot-exe - бот подключится к базам данных, которые Вы указали в файле и начнет работу.

🔧 Technologies & Tools

Code Go DB Mongo DB Redis Linter GoLinter

🎛️ Hints for developers

  • MongoDB localhost:27017
  • Redis localhost:6379
  • MongoExpress localhost:8081
    • docker-compose --profile=debug up для запуска
  • После измменений в коде, пересоберите бота
    • docker-compose build app

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages