search

Wissididom / Twitch-Follows-To-Discord

1 stars 0 forks source link

Documentation #17

Closed xstana closed 7 months ago

xstana commented 7 months ago

Hi buddy, what you did looks really great but I couldn't use it because there is no documentation, can you help me?

Wissididom commented 7 months ago

It's just because I hadn't expected it to be found by anyone. To run it you just need to download/clone the repo and inside that repo do:

  1. Copy example.env to .env and inside the .env set it's values (Format Key=Value)
  2. Run npm i or npm install to install dependencies to the node_modules folder
  3. Run node index.js (I might add a start script at some point tho, so you can just do npm start)

At least Node 18 needs to be installed on the system.

What it does is that it notifies in a Discord Channel though a Webhook who follows or unfollows and at what time and for that requests the twitch api every 5 seconds.