dylan/vod-system
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README with .env file setup instructions

Browse Source 
Added instructions for creating .env files before starting the application.
This commit is contained in:
Dylan De Faoite
2025-12-15 15:32:51 +00:00
committed by GitHub
parent 739d215c27
commit 53f8664b40
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -13,12 +13,14 @@ This VoD system began as a small project back in my 5th year of secondary school
- JDK 21+ - JDK 21+
- Node.js 16+ - Node.js 16+
- FFMPEG - FFMPEG
- Google Client keys
## Steps ## Steps
1. Spin up docker container with `docker compose up` 1. Create your own two `.env` files based off the `example.env` files in the root and in the frontend folder
2. Run `./mvnw clean package` to build the jar 2. Spin up docker container with `docker compose up`
3. Run `./mvnw spring-boot:run` to run the backend section 3. Run `./mvnw clean package` to build the jar
4. Run `cd frontend && npm install && npm run dev` to build and run the frontend 4. Run `./mvnw spring-boot:run` to run the backend section
5. Endpoints should be available at 8080 (backend) and 5173 (frontend) 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 # Future Plans
@@ -32,4 +34,4 @@ This VoD system began as a small project back in my 5th year of secondary school
- **Testing** - **Testing**
- Unit tests, including coverage for FFMPEG-related functionality - Unit tests, including coverage for FFMPEG-related functionality
- **API Documentation** - **API Documentation**
- Comprehensive and maintainable backend API docs - Comprehensive and maintainable backend API docs