https://github.com/xzeldon/telegram-bot-starter
Telegram bot starter template based on grammY framework
https://github.com/xzeldon/telegram-bot-starter
bot grammy starter telegram template
Last synced: 2 months ago
JSON representation
Telegram bot starter template based on grammY framework
- Host: GitHub
- URL: https://github.com/xzeldon/telegram-bot-starter
- Owner: xzeldon
- Created: 2022-05-02T01:47:33.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-02T01:51:58.000Z (about 3 years ago)
- Last Synced: 2025-01-18T09:33:59.376Z (4 months ago)
- Topics: bot, grammy, starter, telegram, template
- Language: TypeScript
- Homepage:
- Size: 813 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Telegram bot starter template based on [grammY](https://grammy.dev)
* Based on [telegram-bot-starter
](https://github.com/Borodutch/telegram-bot-starter) by [@Borodutch](https://github.com/Borodutch). Modified according to the [author's](https://github.com/xzeldon) preferences.
## Installation and local launch
1. Clone this repo: `git clone https://github.com/xzeldon/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 dev`
And you should be good to go! Feel free to fork and submit pull requests. Thanks!
## Environment variables
- `TG_TOKEN` — Telegram bot token
- `MONGO_URI` — URL of the mongo database
- `MONGO_DB_NAME` — Name 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!
## Acknowledgements
* Repo: [telegram-bot-starter
](https://github.com/Borodutch/telegram-bot-starter) by [@Borodutch](https://github.com/Borodutch).