Update theme and documentation (#7)

* Set default theme to light in `ThemeContext`

* Update README and environment configuration files for clarity and completeness and to reflect current project status

* Update dark theme colour scheme

README.md

@@ -2,7 +2,8 @@
 
 ## Overview and Purpose
 
-For our project, we are creating a live streaming platform called Gander. The purpose of this project is to provide a source of entertainment to users and create a community for those with similar interests. In it, users will be able to watch live streams from other users, either gaming or in real life. Alternatively, users can stream themselves on the platform. If a user wants to go live, they can click the “Go Live” button when they are logged in. They will then be presented with a dashboard, so that they can choose their stream's title, category and thumbnail (if they wish to, otherwise a default thumbnail will be chosen). Users who are watching a live stream can interact with other viewers and the streamer through a chat feature. If a user likes a streamer enough, they can subscribe to them using the Stripe API on a monthly basis, for as many months as they wish.
+Gander is a live streaming platform created as a 3rd year team software project as part of UCC's Computer Science degree. It provides a source of entertainment and a community for users with similar interests. Users can watch live streams from other users, whether gaming or IRL, or broadcast their own content. By clicking the "Go Live" button, a logged-in user is presented with a dashboard where they can set their stream's title, category, and thumbnail. Users watching a live stream can interact with other viewers and the streamer through a live chat. Users can also subscribe to their favourite streamers via the Stripe API on a monthly basis.
+
 ![Screenshot 2025-03-03 123446](https://github.com/user-attachments/assets/a23c2974-9500-492d-be07-91161606e805)
 
 ![Screenshot 2025-03-03 125748](https://github.com/user-attachments/assets/ab2092a3-c599-4a90-a616-f08faa4c76ba)
@@ -17,13 +18,13 @@ The platform implements three-tier access control:
 
 2. **Regular Access** (Authenticated Users)
    - All features available to non-authenticated users
-   - Ability to donate to streamers through Stripe integration
+   - Donate to streamers through Stripe integration
    - Interact with streams through comments
    - Follow other users
-   - Option to become a content creator and start streaming
+   - Become a content creator and start streaming
 
 3. **Admin Access**
-   - Complete platform management capabilities
+   - Full platform management capabilities
    - Content moderation tools
    - User account management
    - System configuration controls
@@ -51,28 +52,39 @@ The platform implements three-tier access control:
 - Docker for containerization and deployment
 - Docker Compose for multi-container orchestration
 - Nginx for reverse proxy and RTMP streaming server
-- Uses a microservices architecture
+- Microservices architecture
-
-## Future Development
-
-While our current focus is on the web platform, we've architected the system with potential mobile expansion in mind, particularly through React Native for Android development.
 
 ## Development
 
-This project is actively maintained on GitHub with all team members contributing through version control. We follow collaborative development practices with regular code reviews and feature branches.
+This project was maintained on GitHub, with all team members contributing through version control. The team followed collaborative development practices including regular code reviews and feature branches.
 
-## Running the Current Implementation of the Project
+## Future Development
 
-The current implementation can be run, in development mode, using the following method:
+Development on Gander has concluded. Potential extensions that were not implemented include:
 
-- Pre-requisites:
+- **User Profiles**: Customizable profiles showcasing streaming history, followers, and personal information.
-  - Docker
+- **Enhanced Chat Features**: Emojis, chat moderation tools, and the ability to pin messages during live streams.
-  - Docker Compose
+- **Mobile Application**: A mobile app built with React Native to allow users to watch and stream on the go.
-  - Node.js & npm
+- **Monetization Options**: Additional revenue streams for content creators, such as merchandise sales or one-time donations.
+- **Analytics Dashboard**: A dashboard for streamers to track viewership, engagement metrics, and revenue over time.
 
-1. Replace `.env.example` files with `.env` and fill in the required environment variables
+## Running the Project
-2. Launch Docker containers using either:
+
-   - `docker-compose up --build` in terminal
+Pre-requisites:
-   - Right click within the editor within `docker-compose.yml` and select `Compose Up`
+
-   This will start the frontend, backend, and database services
+- [Docker](https://docs.docker.com/get-docker/) (includes Docker Compose)
-3. Access the frontend at `localhost:8080` in your browser
+- Node.js & npm (optional, for local frontend development)
+
+Steps:
+
+1. Rename the following `.env.example` files to `.env` and fill in the required values:
+   - `frontend/.env.example` — React frontend variables
+   - `web_server/.env.example` — Flask backend variables
+2. Start all services with Docker Compose:
+
+   ```bash
+   docker compose up --build
+   ```
+
+   > **Note:** Older versions of Docker use `docker-compose` (with a hyphen) instead of `docker compose` (with a space).
+3. Access the frontend at `localhost:8080` in your browser. Note that the terminal output from Vite will show `localhost:5173` — this is the internal container port. Nginx exposes the application on port `8080`.

docker-compose.yml

@@ -21,7 +21,7 @@ services:
     networks:
       - app_network
     env_file:
-      - .env
+      - web_server/.env
     environment:
       - FLASK_APP=blueprints.__init__
       - FLASK_ENV=production
@@ -39,7 +39,7 @@ services:
     environment:
       - VITE_API_URL=/api
     env_file:
-      - .env
+      - frontend/.env
     depends_on:
       - web_server
 
@@ -79,12 +79,10 @@ services:
   stripe-cli:
     image: stripe/stripe-cli
     container_name: stripe-cli
+    entrypoint: /bin/sh
     command:
-      - listen
+      - -c
-      - --api-key
+      - stripe listen --api-key $$STRIPE_SECRET_KEY --forward-to http://web_server:5000/stripe/webhook
-      - ${STRIPE_SECRET_KEY}
-      - --forward-to
-      - http://web_server:5000/stripe/webhook
     env_file:
       - web_server/.env
     networks:

frontend/.env.example

@@ -0,0 +1,5 @@
+# Frontend environment variables
+# Note that in Vite, all environment variables must be prefixed with VITE_ to be exposed to your frontend code.
+
+VITE_API_URL=http://127.0.0.1:8080/api
+VITE_STRIPE_PUBLISHABLE_KEY=<insert_your_stripe_publishable_key_here>

frontend/src/assets/styles/index.css

@@ -89,7 +89,7 @@ body[data-theme="light"] {
 
 body[data-theme="dark"] {
   /*Global Background Colour*/
-  background: linear-gradient(to top right, #737787, #0d1e55, #567419);
+  background: linear-gradient(to top right, #0f2058, #020f39, #89058d);
   --scrollbar-color: rgb(255, 255, 255);
   --scrollbar-hover: rgb(255, 255, 255);
 

frontend/src/context/ThemeContext.tsx

@@ -17,11 +17,11 @@ interface ThemeContextType {
 const ThemeContext = createContext<ThemeContextType | undefined>(undefined);
 
 export const ThemeProvider = ({ children }: { children: ReactNode }) => {
-  // Set default theme to dark
+  // Set default theme to light
 
   const [theme, setTheme] = useState<string>(() => {
     // If exist on user cache, use that instead
-    return localStorage.getItem("user-theme") || "dark";
+    return localStorage.getItem("user-theme") || "light";
   });
 
   useEffect(() => {

web_server/.env.example

@@ -0,0 +1,20 @@
+# Backend environment variables
+
+# Secret Keys
+FLASK_SECRET_KEY=<insert_your_flask_secret_key_here>
+AUTH_SECRET_KEY=<insert_your_auth_secret_key_here>
+
+# Email Configuration
+EMAIL=<insert_the_email_to_send_from_here>
+EMAIL_PASSWORD=<insert_your_email_password_here>
+
+# Google OAuth Credentials
+GOOGLE_CLIENT_ID=<insert_your_google_client_id_here>
+GOOGLE_CLIENT_SECRET=<insert_your_google_client_secret_here>
+
+# Stripe
+GANDER_SUBSCRIPTION=<insert_your_stripe_product_id_here>
+STRIPE_SECRET_KEY=<insert_your_stripe_secret_key_here>
+STRIPE_ENDPOINT_SECRET=<insert_your_stripe_endpoint_secret_here>
+
+HOMEPAGE_URL=http://127.0.0.1:8080