Welcome to Fossflix, a web-based platform designed to share and discover free and open-source software (FOSS) related videos. Our platform aims to create a community-driven space where users can engage with educational content, tutorials, and discussions around FOSS projects and technologies.
Fossflix offers a variety of features tailored to enhance user experience and content accessibility:
- User Authentication: Secure login and registration system, allowing users to access personalized features based on their roles.
- Content Discovery: Viewers can explore a wide range of videos through keyword and genre-based search functionalities.
- Movie Management: Editors have the ability to upload, delete, and edit movie entries, including adding detailed descriptions and tags for easier discovery.
- User Roles and Permissions: Differentiated access control for viewers, editors, marketing managers, and administrators, ensuring a tailored user experience.
- Interactive Engagement: Users can like movies and leave comments, fostering an interactive community.
To set up Fossflix on your local machine, follow these steps:
Ensure you have the following installed:
- Node.js
- npm (Node Package Manager)
- MongoDB
- ffmpeg (for video processing)
- Clone the repository:
git clone https://github.com/orlb/fossflix
- Navigate to the cloned directory:
cd fossflix
- Install the required Node.js packages:
npm install
-
Configure your environment variables in
config/default.jsonto match your local setup, especially the MongoDB URI. -
Start the server:
npm run test
Your local instance of Fossflix should now be running and accessible at http://localhost:8443 (or whichever port you configured).
Setup via docker-compose
Ensure you have the following installed:
- Docker
- Docker-compose
- Start the docker service:
sudo systemctl start docker
- Clone the repository:
git clone https://github.com/orlb/fossflix
- Navigate to the cloned directory:
cd fossflix
- Build and run the fossflix image via docker-compose:
sudo docker-compose up
Your local instance of Fossflix should now be running and accessible at http://localhost:8443.