- Docker
- Docker Compose
- Git
- Clone the repository with submodules:
git clone --recursive https://github.com/pointedsec/MediaFlow.git
- Navigate to the project directory:
cd MediaFlow
- Modify the
docker-compose.yml
file with the following environment variables:
environment:
PORT: 3000
JWT_SECRET: "REPLACE WITH A SAME LENGTH JWT SECRET OR USE THE DEFAULT USED IN THE ORIGINAL FILE"
GOOGLE_CLOUD_API_KEY: "YOUR_GOOGLE_CLOUD_API_KEY"
- Modify the
./client/.env
file with your local/public IP Address (remember, the API have to be reachable from the public to expose this to the internet, so do your port forwarding okay!)
VITE_API_URL = "http://192.168.1.111:3000/api/"
- Start the application using Docker Compose:
docker compose up --build -d
This will start the following services:
- API (Backend) - Available at
http://localhost:3000
- Client (Frontend) - Available at
http://localhost:5173
To stop the services
docker compose down
To view logs:
docker compose logs -f
MediaFlow/
├── api/ # Backend API service
├── client/ # Frontend client service
└── docker-compose.yml
- Fork the repository (Or api/client repository)
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.