- Refactor of StreamsContext:

Added `featuredCategories` section,
Added personalised variations of HomePage contents;
- Removal of redundant/unused files from backend;
- Update to README: Updated to current method for deploying;
- Known bug: StreamsContext is being called before AuthContext, leading to unpersonalised streams & categories each time, even when logged in;
This commit is contained in:
Chris-1010
2025-01-24 17:23:56 +00:00
parent b9e912af1d
commit 5c16092b1c
18 changed files with 200 additions and 121 deletions

View File

@@ -4,7 +4,7 @@
Our project is a live streaming service that enables content creators to broadcast to viewers through a web-based platform. The application consists of a React-based frontend that users access to watch streams, and a Flask backend that manages the core functionality and business logic.
## Access Control Levels
### Access Control Levels
The platform implements three-tier access control:
@@ -28,18 +28,21 @@ The platform implements three-tier access control:
## Technical Stack
### Frontend
- React with TypeScript for type safety
- Tailwind CSS for styling
- Video.js for stream playback
- Stripe integration for payment processing
### Backend
- Python with Flask web framework
- SQLite database for data persistence
- Flask-Session for user session management
- Nginx RTMP module for stream handling
### Infrastructure
- Docker for containerization and deployment
- Docker Compose for multi-container orchestration
- Nginx for reverse proxy and RTMP streaming server
@@ -52,12 +55,18 @@ While our current focus is on the web platform, we've architected the system wit
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.
## Running the Current Implementation of the Project
# Running the Current Implementation of the Project
The current implementation can be run, in development mode, using the following method:
1. With the Docker VSCode extension installed, right click within the editor with the `docker-compose.yaml` file active.
Select `Compose Up`
![image](https://github.com/user-attachments/assets/d68dd3b1-f3de-4780-b957-055cb536446b)
Now the backend is up and running on `http://127.0.0.1:8080`.
2. Next, having Node.js & Vite installed, `cd` into `web_server/frontend` and execute the command `npm run dev`. This should startup the frontend section of the application. However, this is only a temporary method as a Docker solution is in development for this frontend part of the project.
3. Navigate to the localhost link given in the terminal upon executing the last command (`http://localhost:5173/`).
- Pre-requisites:
- Docker
- Docker Compose
- Node.js & npm
1. Replace `.env.example` with `.env` and fill in the required environment variables
2. Launch Docker containers using either:
- `docker-compose up --build` in terminal
- Right click within the editor within `docker-compose.yml` and select `Compose Up`
This will start the frontend, backend, and database services
3. Access the frontend at `localhost:8080` in your browser