diff --git a/README.md b/README.md index 1d11efbae05..837811eaa83 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,104 @@ -# Free-Telegram-Store-Bot -I made this Bot Free 100%. +# Free Telegram Store Bot -The Telegram Store Bot you can use for selling and managing your products, services, and orders. +![Python](https://img.shields.io/badge/python-3.10%2B-blue) +![Flask](https://img.shields.io/badge/flask-3.0-lightgrey) +![License](https://img.shields.io/github/license/indmdev/Free-Telegram-Store-Bot) + +A free Telegram store bot for selling digital products or services, collecting orders, and managing a simple storefront workflow. + +## Table of Contents +- [Features](#features) +- [Project Structure](#project-structure) +- [Requirements](#requirements) +- [Installation](#installation) +- [Configuration](#configuration) +- [Usage](#usage) +- [Screenshots](#screenshots) +- [Notes](#notes) +- [License](#license) + +## Features +- Telegram bot workflow for product listings and order handling +- Flask-based local service components +- Environment-based configuration with `config.env` +- Simple Python entrypoint for local deployment +- Easy to customize for private stores or service catalogs + +## Project Structure + +```text +. +├── store_main.py +├── purchase.py +├── utils.py +├── config.py +├── config.env +├── requirements.txt +└── guide.txt +``` + +## Requirements +- Python 3.10 or newer +- Git +- A Telegram bot token from [@BotFather](https://t.me/BotFather) +- An [ngrok](https://ngrok.com/) tunnel if your deployment flow needs a public callback URL + +## Installation +1. Clone the repository: + + ```bash + git clone https://github.com/indmdev/Free-Telegram-Store-Bot.git + cd Free-Telegram-Store-Bot + ``` + +2. Create and activate a virtual environment (recommended): + + ```bash + python -m venv .venv + source .venv/bin/activate + ``` + + On Windows: + + ```powershell + .venv\Scripts\activate + ``` + +3. Install dependencies: + + ```bash + pip install -r requirements.txt + ``` + +## Configuration +1. Create your bot with [@BotFather](https://t.me/BotFather) and copy the bot token. +2. Open `config.env` and fill in the required values. +3. Add your ngrok URL if your bot flow depends on external callbacks. +4. Set the store currency and any additional project-specific values. + +## Usage +1. Start ngrok if you need a public URL: + + ```bash + ngrok http 5000 + ``` + +2. Run the bot from the project folder: + + ```bash + python store_main.py + ``` + +3. Open Telegram and test the bot with your configured bot account. + +## Screenshots + +![Store bot preview](https://i.ibb.co/6tvrHzH/v5-1.png) + +## Notes +- This repository is presented as a free version of the author's Telegram store bot. +- For advanced customization, the original README points users to [@InDMDev](https://t.me/InDMDev). +- Use this project only for legal and compliant purposes. -![image1](https://i.ibb.co/6tvrHzH/v5-1.png) - - -# Message me at [@InDMDev](https://t.me/InDMDev) for your advanced Bots customizations. - - -For more Bots like this, and to be the first to know when I publish free bots, join my channel: [@InDMDevBots](https://t.me/InDMDevBots) - - -# Guide -1. Install Python 3.10 -2. Install any git version -3. Open terminal -4. Run this command in your terminal "git clone https://github.com/indmdev/Free-Telegram-Store-Bot.git" -5. Run this command in your terminal "cd Free-Telegram-Store-Bot-main" -6. Run this command in your terminal: "pip install -r requirements.txt" -7. Set up a free NGROK account at https://ngrok.com -8. Open another terminal and run your Ngrok -9. Setup your new Bot at [@BotFather](https://t.me/Botfather) -10. Open the config.env file -11. Add your Bot Token (Provided to you by [@BotFather](https://t.me/Botfather)) -12. Add your Ngrok URL -13. Add your Store Currency -14. Save and close the file -16. Run the "python store_main.py" command in your terminal from the "Free-Telegram-Store-Bot-main" folder -17. Completed - - - -# Upgraded version of this FREE Bot 👉: [@InDMShopV5Bot](https://t.me/inDMShopV5Bot) - -# [Our Classic Bot Features:](https://i.ibb.co/6tvrHzH/v5-1.png) - -# Test and Subscribe To Classic Bot 👉 [@InDMShopBot](https://t.me/InDMShopBot) [Check Demo](https://t.me/InDMMarketbot) - - - -# Version 6 coming soon 👇: -![photo_2025-09-10 08 21 53](https://i.ibb.co/8mhDS9F/v5-2.png) - -# Languages in version 6 coming soon 👇: -![photo_2025-09-10 08 21 53](https://i.ibb.co/d54nQJ7/v5-3.png) - - - -🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 -# Note: Use this program only for legal purposes, InDMDev is not and will not be responsible for any illegal activity/activities you indulge in using this program. -🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 - - -# MAKE THE WORLD A BETTER PLACE 🙏 +## License +See [LICENSE](LICENSE).