ramforth/MultiChatOverlay
3
2
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases Wiki Activity

prep: Making way for the planned 'Dashboard' page and correcting Twitch bot scope, corrected.

Browse Source
This commit is contained in:
ramforth
2025-11-17 01:28:47 +01:00
parent 6ed78cf3fb
commit 35c2210305
2 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@@ -79,4 +79,21 @@ This is the process you will follow *every time* you want to add a new feature o
* You will see a prompt to "Open a Pull Request" for your new branch. * You will see a prompt to "Open a Pull Request" for your new branch.
* Fill it out, describe your changes, and submit it for review. * Fill it out, describe your changes, and submit it for review.
A project lead will then review your code, and once approved, it will be merged into the `main` branch and deployed to the staging server for final testing. A project lead will then review your code, and once approved, it will be merged into the `main` branch and deployed to the staging server for final testing.
🚀 Automatic Deployment (The Webhook)
We have set up an automated "hotline" that connects our code storage (Gitea) to our live server.
Here's how it works:
**Code is Saved**: A developer saves new code to our Gitea project.
**Gitea Calls the Server**: Gitea immediately "calls" a special, secret address on our server.
**Server Verifies the Call**: A "listener" program on the server answers and checks a secret password to make sure the call is genuinely from Gitea and not an impostor.
**Server Updates Itself**: Once verified, the listener automatically runs our deploy.sh script. This script fetches all the new code and restarts the application.
The result: The server is always running the latest version of the code, and no one has to log in to update it manually. It's completely automatic.

2
DEVELOPMENT_PLAN.md
View File

@@ -41,7 +41,7 @@ The goal is to create a service where streamers can log in using their platform
## 4. Requirements for Completion (Initial Version) ## 4. Requirements for Completion (Initial Version)
The project will be considered complete for its initial version when Phases 1, 2, and 3 are functional: The project will be considered complete for its initial version when Phases 1, 2, and 3 are functional:
1. Users can log in with their Twitch account. 1. Users can log in with their Twitch account.
2. Users can see their unique overlay URL on a dashboard. 2. Users can see their unique overlay URL on a dashboard.
3. The overlay successfully connects to their Twitch chat and displays messages when opened in a browser source. 3. The overlay successfully connects to their Twitch chat and displays messages when opened in a browser source.