From 53f8664b40a8e63797a1adbd892f15f77b916629 Mon Sep 17 00:00:00 2001 From: Dylan De Faoite <98231127+ThisBirchWood@users.noreply.github.com> Date: Mon, 15 Dec 2025 15:32:51 +0000 Subject: [PATCH] Update README with .env file setup instructions Added instructions for creating .env files before starting the application. --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c39d3cd..f0ba2f5 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,14 @@ This VoD system began as a small project back in my 5th year of secondary school - JDK 21+ - Node.js 16+ - FFMPEG +- Google Client keys ## 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) +1. Create your own two `.env` files based off the `example.env` files in the root and in the frontend folder +2. Spin up docker container with `docker compose up` +3. Run `./mvnw clean package` to build the jar +4. Run `./mvnw spring-boot:run` to run the backend section +5. Run `cd frontend && npm install && npm run dev` to build and run the frontend +6. Endpoints should be available at 8080 (backend) and 5173 (frontend) # Future Plans @@ -32,4 +34,4 @@ This VoD system began as a small project back in my 5th year of secondary school - **Testing** - Unit tests, including coverage for FFMPEG-related functionality - **API Documentation** - - Comprehensive and maintainable backend API docs \ No newline at end of file + - Comprehensive and maintainable backend API docs