https://github.com/likipiki/uwdbot

UwdChat telegram bot
https://github.com/likipiki/uwdbot

golang telegram uwd

Last synced: about 16 hours ago
JSON representation

UwdChat telegram bot

• Host: GitHub
• URL: https://github.com/likipiki/uwdbot
• Owner: LikiPiki
• Created: 2019-06-25T09:15:04.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-22T07:53:54.000Z (over 3 years ago)
• Last Synced: 2023-02-27T20:14:46.033Z (over 1 year ago)
• Topics: golang, telegram, uwd
• Language: Go
• Homepage:
• Size: 7.4 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
## 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``