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

https://github.com/flagro/botfishinggame

A fun open-source Telegram bot for chats, developed to improve my knowledge in microservices and CI/CD pipelines.
https://github.com/flagro/botfishinggame

cicd database fishing-game github-actions mongodb motor python python-telegram-bot python3 telegram telegram-bot

Last synced: 10 months ago
JSON representation

A fun open-source Telegram bot for chats, developed to improve my knowledge in microservices and CI/CD pipelines.

Awesome Lists containing this project

README

          

# Epic Fishing Bot for Telegram 🎣

Epic Fishing Bot is an engaging Telegram bot that allows you to catch, sell, and trade various sea items, all within the comfort of your group chats. Dive in and explore the virtual seas, compete with friends, and trade your treasures, all through simple Telegram commands.

[🤖 Start Playing with @EpicFishingBot](https://t.me/EpicFishingBot)

## Features 🚀

- **Catch Items**: Explore the seas and catch various items.
- **Sell & Trade**: Trade your items or sell them for virtual currency.
- **Group Chat Fun**: Designed to maximize fun in group chats.
- **Leaderboard**: Compete with friends and track your progress.

## Getting Started 🏁

### Prerequisites

- Ensure [Docker](https://www.docker.com/get-started) is installed.

### Running the Project Locally 🚀

1. Clone the repository: `git clone https://github.com/Flagro/BotFishingGame`
2. Navigate to the project directory: `cd BotFishingGame`
3. Create environment variables file: `mv .env-example .env`
4. Add your Telegram token to `.env`: `echo "TELEGRAM_TOKEN=" >> .env`
5. Start the project using Docker: `docker-compose up`

### Note

- Replace `` with your actual Telegram Bot API token.
- Ensure Docker daemon is running before using `docker-compose up`.

## How to Play 🎮

[Send a message](https://t.me/EpicFishingBot) to @EpicFishingBot and start exploring the seas! Whether you're solo sailing or competing with a crew in a group chat, the waters are yours to explore.

(Optionally add more details about commands and gameplay here)

## Contribution 🤝

We welcome contributions from the community! Whether it's bug reports, feature requests, or new additions, your support is always appreciated. Simply:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/YourFeature`)
3. Commit your changes (`git commit -m 'Add some feature'`)
4. Push to the branch (`git push origin feature/YourFeature`)
5. Open a Pull Request

## Support 🚑

Encountered a bug or have a feature request? [Open an issue](https://github.com/Flagro/BotFishingGame/issues) and we'll have a look!

## License 📄

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.