From c54d0305da5198211b64513c22a64a9bdebcd723 Mon Sep 17 00:00:00 2001 From: ThisBirchWood Date: Tue, 3 Jun 2025 10:44:46 +0200 Subject: [PATCH] IMPROVE readme --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cda3443..c39d3cd 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,24 @@ This VoD system began as a small project back in my 5th year of secondary school - Docker & Docker Compose - JDK 21+ - Node.js 16+ +- FFMPEG ## Steps 1. Spin up docker container with `docker compose up` 2. Run `./mvnw clean package` to build the jar 3. Run `./mvnw spring-boot:run` to run the backend section 4. Run `cd frontend && npm install && npm run dev` to build and run the frontend -5. Endpoints should be available at 8080 (backend) and 5173 (frontend) \ No newline at end of file +5. Endpoints should be available at 8080 (backend) and 5173 (frontend) + +# Future Plans + +- **User Management** + - Database integration with authentication and login + - Clip saving and management for authenticated users +- **Format Handling** + - Backend conversion of non-MP4 files via FFMPEG for broader format support +- **Input Sources** + - Support for local file uploads and YouTube imports +- **Testing** + - Unit tests, including coverage for FFMPEG-related functionality +- **API Documentation** + - Comprehensive and maintainable backend API docs \ No newline at end of file