https://github.com/Borodutch/telegram-bot-starter

Telegram bot starter based on grammY
https://github.com/Borodutch/telegram-bot-starter

mongodb telegram telegram-bot

Last synced: 10 days ago
JSON representation

Telegram bot starter based on grammY

• Host: GitHub
• URL: https://github.com/Borodutch/telegram-bot-starter
• Owner: Borodutch
• License: mit
• Created: 2019-04-17T03:11:37.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-04-26T16:09:07.000Z (over 1 year ago)
• Last Synced: 2024-08-01T19:58:59.173Z (3 months ago)
• Topics: mongodb, telegram, telegram-bot
• Language: TypeScript
• Homepage: https://templates.borodutch.com
• Size: 1.17 MB
• Stars: 232
• Watchers: 6
• Forks: 51
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-grammY - Borodutch/telegram-bot-starter - Telegram bot starter based on grammY. (Templates)

README

        
# Telegram bot starter based on [grammY](https://grammy.dev)

Please, enjoy this starter template for Telegram bots based on [grammY](https://grammy.dev). It includes most common middlewares, MongoDB integration, language picker and internationalization and shows basic encapsulation techniques used by me.

# Installation and local launch

1. Clone this repo: `git clone https://github.com/Borodutch/telegram-bot-starter`

2. Launch the [mongo database](https://www.mongodb.com/) locally

3. Create `.env` with the environment variables listed below

4. Run `yarn` in the root folder

5. Run `yarn develop`

And you should be good to go! Feel free to fork and submit pull requests. Thanks!

# Environment variables

- `TOKEN` — Telegram bot token

- `MONGO` — URL of the mongo database

Also, please, consider looking at `.env.sample`.

# License

MIT — use for any purpose. Would be great if you could leave a note about the original developers. Thanks!