GitXplorerGitXplorer
s

First

public
3 stars
2 forks
4 issues

Commits

List of commits on branch master.
Verified
9e3183ee68f88bb9fb1e17a0b49fa8638bdba1ab

fix(twitch_eventsub): subscription is a dict

mmate-amargo committed a year ago
Verified
991abff168f7dbc9ff6876079bc316df19f0ab29

feat(redirect_uri): Use redirect_uri from config

mmate-amargo committed a year ago
Verified
f18b282c0450857353745198bba0ec950344aeb5

feat: Add production server setup using gunicorn

mmate-amargo committed a year ago
Verified
4c3641127081e1ec3fb616d860a15dbe94ea0add

fix(twitch): Handle case of a deleted user

mmate-amargo committed a year ago
Verified
872e9bcf983fe2de79c12919493663c8068a086b

fix: Test points sort in descending order

mmate-amargo committed a year ago
Verified
f78f31b310a126703bc38bd879084eeca0d50387

refactor: Add more tox environments and fix some type-errors

mmate-amargo committed a year ago

README

The README file for this repository.

First! is a Twitch app for the first people to join your streams.

Try First! yourself (production hosted version)

See how it works (YouTube video)

First! is written in Python 🐍

Key features:

  • Leaderboards
  • first -> second -> third progression

Installing & running locally

  1. Install Python 3.11 or newer. Ubuntu: sudo apt install python3
  2. Install Pip. Ubuntu: sudo apt install python3-pip
  3. Install Python venv. Ubuntu: sudo apt install python3-venv
  4. Create a virtual Python environment: python3 -m venv ENV
  5. Install Tox in the virtual Python environment: ENV/bin/pip install tox.
  6. Create a Twitch application:
    1. Visit the Twitch application registration page.
    2. Write any application name allowed by Twitch. Try: "First in chat"
    3. Under OAuth Redirect URLs, write: http://localhost:5000/oauth/twitch
    4. Press Create.
  7. Copy first/config/config.example.toml to first/config/config.toml.
  8. Update first/config/config.toml, following the in-line instructions.
  9. Run the First web server: ENV/bin/tox -e flask

Setting up your stream

  1. Open http://localhost:5000/.
  2. Click the "Add First! to Twitch" button at the bottom.
  3. In the Twitch UI, allow the login. This should redirect you to your First! settings dashboard (http://localhost:5000/manage.html).
  4. Under "Have First! create your first channel point reward automatically", choose a channel point cost then press "Create reward".

A new channel point reward titled "first" should now be enabled for your Twitch stream. It will automatically be changed to "second" or "third" as appropriate.

After viewers redeem the "first", "second", or "third" rewards, you can see how cool they are by looking at the leaderboards:

  1. Open http://localhost:5000/.
  2. Click your stream's name in the leaderboard.

License & copyright

Copyright 2023 Juan Alberto Regalado Galvan, Matthew "strager" Glazar

License: GPL3.0-or-later