Git Product home page Git Product logo

tellerbot's Introduction

TellerBot

Documentation Status Dependabot Status pre-commit GitHub license Telegram Code style: black


@TellerBot is an asynchronous Telegram Bot written in Python to help you meet people that you can swap money with.

Requirements

  • Python >= 3.8
  • MongoDB
  • Motor - asynchronous Python driver for MongoDB
  • AIOgram - asynchronous Python library for Telegram Bot API
  • Emoji - emoji for Python

Installation and launch

Using Docker (recommended)

  1. Clone the repository:
git clone https://github.com/fincubator/tellerbot
cd tellerbot
  1. Create environment file from example:
cp .env.example .env
  1. Personalize settings by modifying .env with your preferable text editor.
  2. Create a new Telegram bot by talking to @BotFather and get its API token.
  3. Create a file containing Telegram bot's API token with filename specified in TOKEN_FILENAME from .env.
  4. Install Docker Compose.
  5. Start container:
docker-compose up

Manual

  1. Clone the repository:
git clone https://github.com/fincubator/tellerbot
cd tellerbot
  1. Install Python version no less than 3.8.
  2. Install requirements:
pip install -r requirements.txt
pip install -r requirements-escrow.txt  # If you're going to support escrow
  1. Create environment file from example:
cp .env.example .env
  1. Personalize settings by modifying .env with your preferable text editor. Remove INTERNAL_HOST and DATABASE_HOST if you want bot and database running on localhost.
  2. Create a new Telegram bot by talking to @BotFather and get its API token.
  3. Create a file containing Telegram bot's API token with filename specified in TOKEN_FILENAME from .env.
  4. Install and start MongoDB server.
  5. Set environment variables:
export $(grep -v '^#' .env | xargs)
  1. Launch TellerBot:
python .

Contributing

You can help by working on opened issues, fixing bugs, creating new features, improving documentation or translating bot messages to your language.

Before contributing, please read CONTRIBUTING.md first.

License

TellerBot is released under the GNU Affero General Public License v3.0. See COPYING for the full licensing conditions.

tellerbot's People

Contributors

r4rdsn avatar dependabot-preview[bot] avatar kwaskoff avatar retsuchisei avatar

Stargazers

ramdhanfamilysr@gmail.com avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.