Giter Club home page Giter Club logo

file-sharing-telegram-bot's Introduction

File Sharing Telegram Bot

Telegram Bot for sharing file. Built using grammY as the Telegram Bot Framework and Typescript. 100% suitable for deploying it to cyclic.sh because this repository is originally purposely built for that.

Primary Tech Stack

  1. grammY
  2. TypeScript
  3. DynamoDB(hosted in cyclic.sh)

Setup at Local

  1. Clone this repo
  2. Create telegram bot using BotFather
  3. Run npm ci to install the dependencies
  4. Create account at cyclic.sh if you haven't. The reason is because you need to use DynamoDB hosted in cyclic.sh. And you can only use it when you have deployed your app to cyclic.sh
    • If you have another DynamoDB, feel free to use it but remember to change the codes
  5. Push this repo to github so you can host it in cyclic.sh
  6. Create .env using the template from .env.sample
    • BOT_TOKEN is the token got from BotFather
    • CYCLIC_DB_NAME is your Table Name. You can check it in Data/Storage section after you hosted your app to cyclic.sh
    • BOT_ID is your bot username
  7. Run nodemon index.ts to run your app
  8. Do coding :D

Deployment

Currently, this repository only support deployment to cyclic.sh. It's free :D

  1. Forked this repository
  2. Create account at cyclic.sh if you haven't
  3. Deploy it to cyclic.sh through github repository
  4. Fill the secret after deployed it
    • BOT_TOKEN is the token got from BotFather
    • CYCLIC_DB_NAME is your Table Name. You can check it in Data/Storage section after you host your app in cyclic.sh
    • NODE_ENV which is production
    • BOT_ID is your bot username
  5. Connect webhook by running
    bash webhook.bash BOT_TOKEN CYCLIC_DEPLOYMENT_URL
  1. Done :D

Contributor

Contributor is welcomed! Just open issue or PR ๐Ÿ™Œ๏ธ

Demo video

TBA

file-sharing-telegram-bot's People

Contributors

liawifelix avatar

Stargazers

KAC CHAN avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

file-sharing-telegram-bot's Issues

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.