Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eomm/telegram-bot-give-away

A giveaway bot for Telegram, build with Fastify and Platformatic
https://github.com/eomm/telegram-bot-give-away

fastify giveaway giveaways telegram-bot

Last synced: 2 months ago
JSON representation

A giveaway bot for Telegram, build with Fastify and Platformatic

Host: GitHub
URL: https://github.com/eomm/telegram-bot-give-away
Owner: Eomm
License: mit
Created: 2023-07-01T09:56:46.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-10-28T21:40:56.000Z (about 1 year ago)
Last Synced: 2024-10-04T17:58:27.646Z (3 months ago)
Topics: fastify, giveaway, giveaways, telegram-bot
Language: JavaScript
Homepage:
Size: 212 KB
Stars: 9
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# telegram-bot-give-away

Open a new chat with [@eommGiveAwayBot](https://t.me/eommGiveAwayBot) and follow the instructions to create or join a new giveaway!

## Commands

- `/start` - Start the bot
- `/help` - Show help
- `/create` - Create a new giveaway. You need to answer 5 questions to create a new giveaway:
1. Event name: short name of the event
2. Event description: long description of the event. Don't forget to include the rules and the exctraction date!
3. Event prize: what is the prize of the giveaway?
4. Number of winners: how many winners will be extracted?
5. Event code: the code to join the event. You will spam this code to let people join the event!
- `/join` - Join an existing giveaway. You will need to provide the event code.
- `/list` - List all the giveaways you created or joined.
- `/extract` - List all the giveaways you created and select one to extract the winners! The winners will receive a notification and the giveaway will be closed.
- `/abort` - Interrupt the current action when the bot expects an answer from you.

## Architecture

- This bot is built using [Telegraf](https://telegraf.js.org/) on top of [Fastify](https://www.fastify.dev/).
- It is deployed on [Platformatic](https://platformatic.cloud/).
- The Postgres database is hosted on [filess.io](https://www.filess.io/).
- The avatar of the bot is created using [Leonardo.AI](https://leonardo.ai/).

![Architecture](./docs/architecture.png)

## Development

To run it locally you need to create a `.env` file with the variables listed in `.env.sample`.
Then you can setup the polling mode or the webhook mode with `ngrok http 3001`.

## License