README.md

Telegram Quiz Bot

OSSCAMEROON QUIZ BOT

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Description

This bot will be seperate on modules...

• the question maker module (based on some inputs, external or internal)
• the publisher module (that will publish on any platform we have)
• the leaderboard module (that will get peoples response and evaluate that for corresponding quiz bots)

(back to top)

Built With

• Python
• Python Telegram Bot

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Python3
• Pip3
• python-telegram-bot

Installation

1. Clone the repo

   git clone https://github.com/osscameroon/tg-gamebot.git

2. Install Python3

   sudo apt-get install python3

3. Install Pip3

   sudo apt install python3-pip

4. Install python-telegram-bot

   pip install python-telegram-bot

5. Install python-telegram bot

   pip3 install python-telegram-bot

6. Enter your API in config.py

   API_KEY = 'ENTER YOUR API';

(back to top)

Testing

• run with

python3 main.py

• open telegram and try it out

(back to top)

Roadmap

• [] question marker
• [] publish Quiz
• [] Leaderboard
  • [] Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you mexampleake are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-new-feature)
3. Commit your Changes (git commit -m 'Add some amazing-new-feature')
4. Push to the Branch (git push origin feature/amazing-new-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

• Andrew Tatah - @nfondandrew73 - [email protected]
• Elroy Kanye - @elroykanye - [email protected]

Project Link: https://github.com/osscameroon/tg-gamebot

(back to top)

Acknowledgments

• Python Telegram Bot
• OSS Cameroon

(back to top)