Hamster Kombat Key/Promo Generator Api

Welcome to the Promo Code Generator repository! This project features implementations of promotional code generators using two popular Python frameworks: Flask and FastAPI. It includes both basic and advanced versions of the generator to accommodate different use cases.

The promotional codes generated by this project are specifically designed for the Hamster Kombat game on Telegram. The code generators facilitate the creation of promo codes for in-game use, enabling promotional activities and user engagement for the game.

README Files

• Flask Basic Promo README
• Flask Advanced Promo README
• FastAPI Basic Promo README
• FastAPI Advanced Promo README
• Flask Basic Promo For Server README
• Flask Advanced Promo For Server README

Overview

The Promo Code Generator enables you to create promotional codes for various categories of games. The project is divided into two main frameworks, each with two versions:

• Flask: A micro web framework for Python.

  • Basic Promo: Generates a fixed number of promo codes for each category.
  • Advanced Promo: Provides customizable parameters for generating promo codes.

• FastAPI: A modern, fast (high-performance) web framework for building APIs with Python.

  • Basic Promo: Generates a fixed number of promo codes for each category.
  • Advanced Promo: Allows for flexible API queries to customize the number of promo codes.

Features

• Basic Promo:

  • Generates a predetermined number of promo codes for each category.
  • Simple and easy-to-use implementation.

• Advanced Promo:

  • Allows for the customization of the number of promo codes generated.
  • Supports query parameters for filtering and adjusting the output.
  • Includes enhanced error handling and validation.

Directory Structure

/project-root
    /Flask
        /basic_promo
            /app.py
            /README.md
        /advanced_promo
            /app.py
            /README.md
    /FastApi
        /basic_promo
            /app.py
            /README.md
        /advanced_promo
            /app.py
            /README.md

Getting Started

1. Clone the Repository:

   git clone https://github.com/mamadceto/H-P-G-Api

2. Navigate to the Desired Framework and Version:

   cd Flask/basic_promo   # or Flask/advanced_promo
   # or
   cd FastApi/basic_promo  # or FastApi/advanced_promo

3. Install Dependencies:

   pip install -r requirements.txt

4. Run the Application:

   - **Flask:**
     python app.py

   - **FastAPI:**
     uvicorn app:app --reload

5. Access the API:

   - **Flask:** http://localhost:5000/generate

   - **FastAPI:** http://localhost:8000/generate

API Usage

• Basic Promo: Generates a fixed number of promo codes (default: 4) for each category.
• Advanced Promo: Customize the number of promo codes and category using query parameters:
  • category (optional): Specify a category such as train, chain, bike, or clone. To generate codes for all categories, use all.
  • num (optional): Specify the number of promo codes to generate. Maximum allowed is 20.

Contributing

Feel free to fork the repository, make changes, and submit pull requests. We welcome contributions that enhance the functionality and usability of the project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For any inquiries or feedback, please contact @mmdceto.