NDragneelL9/the-undermine-bot

The Undermine Bot (ABANDONED)

Author: Tim
Abandoned due to returning of WoW Companion App

Table of content

• What is the goal of this project?
• Requirements 📃
  • Functional requirements (Backlog)
  • Non-functional requirements
• Glossary 📝
• Stakeholders 👤
• Design 📊
  • Database diagram
  • Sequence diagram
  • Use Case diagram
• Architecture 🖼️
  • Static View
  • Dynamic View
• Technical Stack
• Getting started
• Contributing

What is the goal of this project?

The Undermine Bot was inspired by THE UNDERMINE JOURNAL and is supposed to help WoW players with getting live updates on the market.

Technical Stack

The project consists of two main parts: Telegram bot as User interface and Ruby on Rails as back-end service (PostreSQL as main database)

Getting started

1. Clone repository

git clone https://github.com/NDragneelL9/the-undermine-bot.git

2. Change directory to the-undermine-bot and install app gems

cd the-undermine-bot
bundle install

3. Enter telegram bot and Blizzard client credentials using:

EDITOR=nano rails credentials:edit

4. Run poller

rails telegram:bot:poller

5. Send commands to telegram bot

/start

Contributing

Just fork the repository from the develop branch, follow Getting started section, implement changes you want to propose and make a pull request. Also, there are issues in repository, feel free to submit a new one or participate in existing.