Skip to content
This repository has been archived by the owner on Jun 2, 2024. It is now read-only.

Nickwasused/twitch-search-server

Repository files navigation

Twitch Search Server

Status License


Search through all livestreams on Twitch

πŸ“ Table of Contents

🧐 About

This project can host a FastAPI server with that you can search through all streams currently live on Twitch.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

python3 is required.
uvicorn[standard] is required.

Installing

Install the required packages and uvicorn by running:

pip install -r requirements.txt
pip install uvicorn[standard]

After that copy the example Environment variables to use them:

cp .env.example .env

Now you need to fill in the missing values in the .env file.

🎈 Usage

Only one endpoint is available which is at /search.
You can filter the streams by title.

There are automatically generated docs at http://localhost:8000/docs or https://tts-de-gta5.nickwasused.com/docs

πŸš€ Deployment

A Dockerfile is available at ./Dockerfile The default listening Port is 8000.

There is a default instance available at https://tts-de-gta5.nickwasused.com/docs. This instance is filtering for german streams playing Grand Theft Auto V. https://uptime.nickwasused.com/status/tss

Style

The code is formatted and checked with ruffs default settings.

⛏️ Built Using

Affiliation

I am not affiliated with Twitch Interactive, Inc.