Notifications

.gitignore

@@ -10,7 +10,7 @@ web-build/
 data/
 media/
 examples/
-package-lock.json
+package-lock.*
 
 .env
 

README.md

@@ -9,6 +9,7 @@ A real-time streaming platform that supports live chat from both Twitch and YouT
 - Stream highlights
 - HLS streaming support
 - WebSocket-based real-time updates
+- Email notifications when stream goes live
 
 ## Prerequisites
 
@@ -54,6 +55,11 @@ STREAM_KEY=your_stream_key
 
 # Admin Configuration
 ADMIN_USERNAME=your_admin_username  # Username with admin privileges for managing highlights
+
+# Email Notifications
+EMAIL_NOTIFICATIONS_ENABLED=true
+PROTONMAIL_USER=your_protonmail_email
+PROTONMAIL_PASS=your_protonmail_password
 ```
 
 ## Configuration
@@ -76,6 +82,21 @@ The following environment variables must be set in your `.env` file:
 #### Admin Configuration
 - `ADMIN_USERNAME`: Username with administrative privileges for managing highlights and other admin-only features
 
+#### Email Notifications
+- `EMAIL_SYSTEM_ENABLED`: Set to `true` to enable the email system
+- `EMAIL_NOTIFICATIONS_ENABLED`: Set to `true` to enable email notifications
+- `EMAIL_PROVIDER`: Set as email provider (smtp/resend)
+- `EMAIL_FROM`: Who the email is from
+- `RESEND_API`: Set resend API
+
+#### SMTP Configuration (if using SMTP provider)
+EMAIL_HOST=smtp.gmail.com
+EMAIL_PORT=587
+EMAIL_SECURE=false
+`EMAIL_USER`: Set gmail email
+`EMAIL_PASS`: Set gmail special key
+
+
 ### Stream Key
 
 The stream key is configured through the `STREAM_KEY` environment variable in your `.env` file. If not set, it defaults to `StreamtoME`. This key is used for RTMP authentication and HLS stream paths.
@@ -178,4 +199,15 @@ git push origin feature/your-feature-name
 
 ## License
 
-This project is licensed under the MIT License - see the LICENSE file for details.
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Email Notifications
+
+The server includes an email notification system that alerts subscribers when the stream goes live. To use this feature:
+
+1. Set `EMAIL_NOTIFICATIONS_ENABLED=true` in your `.env` file
+2. Configure your ProtonMail credentials:
+   - `PROTONMAIL_USER`: Your ProtonMail email address
+   - `PROTONMAIL_PASS`: Your ProtonMail password or app-specific password
+3. Subscribers can sign up through the form on the website
+4. Notifications are automatically sent when the stream starts