Skip to content

LikiPiki/UwdBot

Repository files navigation

UwdBot - бот для телеграм чатика UWD

Привет, ты наверное заинтересовался этим репозиторием и решил немного сюда поконтрибьютить? Если так то читай небольшой мануал как поднять данный проектик у себя локально. Звездочки очень приветствуется!

Как мне начать скопировать проект к себя локально?

Клонируем репозиторий в $GOPATH/src/github.com/likipiki/UwdBot

git clone https://github.com/LikiPiki/UwdBot

Активируем гит хуки на сборку и тесты перед коммитом

git config core.hooksPath hooks

Указываем в .env

TOKEN=Токен бота
DATABASE_URL=postgresql://localhost/uwd
CHAT_ID=-1001094145433

Создаем базу данных (предвариельно нужно установить postgreSQL)

psql
create database uwd;
\c uwd
\i scheme.sql

Будет создана схема данных, и добавлены некоторые дефолтные элементы, подробнее можно посмотреть в scheme.sql

Как запустить проект?

make
./uwdbot

Что делать если что-то пошло не так или вы заметили баг?

Если баг простой, почините и закомитьте изменения, предложите пулл реквест! Если вам сложно починить, создайте issue тут!

Как законтрибьютить?

Форкайте, предлагайте измнения, создавайте пулл реквест. Обязательно пройдите после пуша тесты в Actions.

Как создать свой кусок реализации будь то мини игра или другой функционал?

Для этого есть система плагинов, подробнее о ней можно узнать в папке internal/pkg/plugin