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

Nickwasused/streaming-list

Repository files navigation

Streaming list

Status License


A searchable, auto-updating list of streamers for a certain topic.

📝 Table of Contents

🧐 About

A searchable, auto-updating list of streamers for a certain topic.

🏁 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

pnpm is required
twitch-search-server instance is required

Installing

Install the dependencies with:

pnpm install

Then you can open your browser and see the page at http:https://127.0.0.1:3000/.

🎈 Usage

Here are a few preview images of the deployed site:

https://github.com/Nickwasused/streaming-list/blob/main/github-images/preview/preview-de.webp https://github.com/Nickwasused/streaming-list/blob/main/github-images/preview/preview-de.webp

Here are the google pagespeed stats:

https://github.com/Nickwasused/streaming-list/blob/main/github-images/speed/desktop.webp https://github.com/Nickwasused/streaming-list/blob/main/github-images/speed/mobile.webp

🚀 Deployment

You can see a deployment example at ./.github/workflows/build-and-deploy.yml

Style

The code is formatted and checked with prettiers default settings.

⛏️ Built Using

Affiliation