brianmaleek/Crypto_Hub

CRYPTO-HUB

Table of Contents

• CRYPTO-HUB
  • Table of Contents
  • Introduction
  • Features
  • Technology Stack
  • Getting Started
    • Prerequisites
    • Installation
    • Configuration
  • Usage
  • Contributing
  • License
  • Acknowledgments

Introduction

The Telegram bot utilizes a crypto API to provide users with real-time data on cryptocurrency, including current prices, transaction volumes, and other relevant coin-specific information.

Features

1. Real-time Price Updates: Stay informed with up-to-the-minute cryptocurrency prices.
2. News Feed Integration: Receive the latest news about the cryptocurrency market.
3. User Queries: Interact with the bot to get information about specific cryptocurrencies.

Technology Stack

Before you begin, ensure you have the following:

1. Python (Python3): The primary programming language for the bot.
2. Flask: A micro web framework built in Python.
3. Python-telegram-bot: A Telegram API wrapper in Python.
4. Requests: A popular Python HTTP library.
5. Telegram: The messaging platform used to host the bot.
6. Heroku: A cloud platform used for deployment.

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

1. Python 3
2. Flask
3. python-telegram-bot
4. Requests
5. Telegram account
6. Heroku account

Installation

1. Clone this repository to your local machine.

   git clone <https://github.com/your-username/Crypto_Hub.git>
   cd Crypto_Hub

2. Install the required dependencies.

   pip install -r requirements.txt  # For Python

3. Install Heroku CLI for deployment. Follow the instructions on the Heroku website to install the CLI for your operating system.

   heroku login

Configuration

1. Create a new Telegram bot on BotFather.

2. Note down the token provided by BotFather.

3. Obtain API keys for cryptocurrency data from providers such as CoinGecko or CoinMarketCap.

4. Configure your bot by creating a .env file with the following content:

   TELEGRAM_BOT_TOKEN=your-telegram-bot-token
   CRYPTO_API_KEY=your-crypto-api-key

Usage

1. Run your bot application.

   Replace with your startup command
   python bot.py  # For Python

2. Start a chat with your bot on Telegram.

3. Use the available commands to interact with the bot and receive cryptocurrency information.

Contributing

Contributions are welcome! If you'd like to contribute to the project, please follow these guidelines:

• Fork the repository.
• Create a new branch for your feature or bug fix.
• Make your changes and submit a pull request.

License

This project is licensed under the MIT License.

Acknowledgments

Special thanks to the creators of the Telegram API and cryptocurrency data providers.

1. Brian Kin Maleek (maleekmalik@gmail.com)
2. Esther Wachuka (estherwachukangaru@gmail.com)