diff options
| author | Pinapelz <yukais@pinapelz.com> | 2023-11-18 22:05:04 -0800 |
|---|---|---|
| committer | Pinapelz <yukais@pinapelz.com> | 2023-11-18 22:05:04 -0800 |
| commit | c885ccbe486f5bee379e0db0e17a281bbbf904f9 (patch) | |
| tree | 5321ed15d40adf0fe1f0557fb8a9c817aa4b9881 | |
| parent | e8bf6d7fb29945bf3c3bc3356a4ae605af509d29 (diff) | |
update README
| -rw-r--r-- | README.md | 31 |
1 files changed, 12 insertions, 19 deletions
@@ -1,5 +1,12 @@ # [NijiTrack](https://nijitracker.com/) -NijiTrack is a set of Python scripts that allows for the visualization and collection of historical subscriber count data for any set of YouTube Channels. + +Historical subscriber count tracker for any subset of YouTube channels. Flask backend and NextJS frontend for visualization. + +This was originally made with the intention of tracking the subscriber count of Virtual YouTubers in the Nijisanji organization, but can be used for any set of channels. + + +# Backend: +Below are the steps to set up the flask backend for data collection and serving data through a web server (`/backend` folder of repo) ### Dependencies - MariaDB or MySQL @@ -19,28 +26,14 @@ HOLODEX_ORG = "Phase%20Connect" ORG_MEMBER_COUNT = 75 ``` 2. Add channels to be excluded from data collection in `data/excluded_channel.txt` -3. Execute with `python main.py` +3. Execute with `python nijitrack.py` #### For collection using a custom set of channels configured in `data/channels.txt` 1. Configure channels in data/channels.txt in the format `YOUTUBE_CHANNEL_ID,CHANNEL_NAME` for each line -2. Execute with `python main.py ytapi` - -An `index.html` is created in your root directory and channel individual pages is created in `stats/*` -You can use `app.py` to host your statics through Flask or use any other services - -### Homepage Subscriber Ranking -# <img src="https://user-images.githubusercontent.com/21994085/229314684-af00962a-b363-4337-9ab1-9f41ed7cc7e1.png" alt="image" width="50%" height="50%"> - -### Individual Page Infocards -# <img src="https://user-images.githubusercontent.com/21994085/229314672-0aa5471a-6991-4018-b684-66e19e0bb34e.png" alt="image" width="50%" height="50%"> - -### General Trend Graph -# <img src="https://user-images.githubusercontent.com/21994085/229314680-0fce8104-f369-4a4c-9c3e-f982a277f03e.png" alt="image" width="50%" height="50%"> +2. Execute with `python nijitrack.py ytapi` -### 7 Day Trend (Data point is recorded each time program is ran) -# <img src="https://user-images.githubusercontent.com/21994085/229314728-fe62ee87-9b8c-4995-8745-f194995d9efd.png" alt="image" width="50%" height="50%"> +A basic graph will be created using plotly and saved to index.html in the root directory -### Individual daily subscriber data -# <img src="https://user-images.githubusercontent.com/21994085/229314763-eeb94642-32a3-49d3-862e-375280f0d6fb.png" alt="image" width="50%" height="50%"> +You can use `app.py` to host your statistics through Flask or use any other services Webpage design inspired by [TrackHololive](https://trackholo.live/) |
