README.md

Hype AI

📋 Table of contents

• Hype AI
  • Description
  • Getting started
    • Run using docker (prod):
    • Installation (development):
    • Run (development)
    • Configuration
    • Prerequisites
  • Usage
  • Testing
  • Team
    • License

Description

HypeAI automates the creation and uploading of videos to social media like TikTok. The videos are generated using AI.

Supported generator are:

• Quiz Videos 🧠
• Guess The Celebrity 🌟

Supported uploaders are:

• TikTok

Getting started

Run using docker (prod):

make run

Installation (development):

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cd tiktok-uploader
hatch build
pip install -e .
cd ..

Run (development)

python main.py

Configuration

Prerequisites

• Ensure that git is installed on your machine. Download Git
• Make
• Docker

Usage

To run the project, run the following command from the root directory of the project:

Testing

To run the test suite, run the following command from the root directory of the project:

Team

This project would not have been possible without the hard work and dedication of all of the contributors. Thank you for the time and effort you have put into making this project a reality.

License

---

Distributed under the MIT License. See LICENSE for more information.