diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8cf64be..2397c18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. * 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. \ No newline at end of file +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. \ No newline at end of file diff --git a/DEVELOPMENT_PLAN.md b/DEVELOPMENT_PLAN.md index 62298df..dbaad8b 100644 --- a/DEVELOPMENT_PLAN.md +++ b/DEVELOPMENT_PLAN.md @@ -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) 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. 3. The overlay successfully connects to their Twitch chat and displays messages when opened in a browser source.