DOCSP-55438 & DOCSP-55529: Unify .env vars and add new verification scripts for all three backends

.copier/config.yaml

@@ -43,6 +43,7 @@ workflows:
       - move: { from: "mflix/client", to: "client" }
       - move: { from: "mflix/server/java-spring", to: "server" }
       - copy: { from: "mflix/README-JAVA-SPRING.md", to: "README.md" }
+      - copy: { from: "mflix/check-requirements-java.sh", to: "check-requirements.sh" }
       - copy: { from: "mflix/.gitignore-java", to: ".gitignore" }
     commit_strategy:
       pr_title: "Update MFlix application from docs-sample-apps"
@@ -68,6 +69,7 @@ workflows:
       - move: { from: "mflix/client", to: "client" }
       - move: { from: "mflix/server/js-express", to: "server" }
       - copy: { from: "mflix/README-JAVASCRIPT-EXPRESS.md", to: "README.md" }
+      - copy: { from: "mflix/check-requirements-js.sh", to: "check-requirements.sh" }
       - copy: { from: "mflix/.gitignore-js", to: ".gitignore" }
     commit_strategy:
       pr_title: "Update MFlix application from docs-sample-apps"
@@ -93,6 +95,7 @@ workflows:
       - move: { from: "mflix/client", to: "client" }
       - move: { from: "mflix/server/python-fastapi", to: "server" }
       - copy: { from: "mflix/README-PYTHON-FASTAPI.md", to: "README.md" }
+      - copy: { from: "mflix/check-requirements-python.sh", to: "check-requirements.sh" }
       - copy: { from: "mflix/.gitignore-python", to: ".gitignore" }
     commit_strategy:
       pr_title: "Update MFlix application from docs-sample-apps"

mflix/README-JAVA-SPRING.md

@@ -28,6 +28,16 @@ The `sample_mflix` dataset contains movies released up to **2016**. Searching fo
 - **Voyage AI API key** (For MongoDB Vector Search)
   - [Get a Voyage AI API key](https://www.voyageai.com/)
 
+## Verify Requirements
+
+Before getting started, run the verification script to check if you have the required runtime:
+
+```bash
+./check-requirements-java.sh --pre
+```
+
+This checks that Java and JAVA_HOME are configured correctly. Run with `--help` for more options.
+
 ## Getting Started
 
 ### 1. Configure the Backend
@@ -48,28 +58,19 @@ Edit the `.env` file and set your MongoDB connection string:
 
 ```env
 # MongoDB Connection
-# Replace with your MongoDB Atlas connection string or local MongoDB URI
 MONGODB_URI=mongodb+srv://<username>:<password>@<cluster>.mongodb.net/sample_mflix?retryWrites=true&w=majority
 
-# Voyage AI Configuration
-# API key for Voyage AI embedding model (required for Vector Search)
+# Voyage AI Configuration (optional - required for Vector Search)
 VOYAGE_API_KEY=your_voyage_api_key
 
 # Server Configuration
-# Port on which the Spring Boot application will run
 PORT=3001
 
 # CORS Configuration
-# Allowed origin for cross-origin requests (frontend URL)
-# For multiple origins, separate with commas
-CORS_ORIGIN=http://localhost:3000
-
-# Optional: Enable MongoDB Search tests
-# Uncomment the following line to enable Search tests
-# ENABLE_SEARCH_TESTS=true
+CORS_ORIGINS=http://localhost:3000
 ```
 
-**Note:** Replace `username`, `password`, and `cluster` with your
+**Note:** Replace `<username>`, `<password>`, and `<cluster>` with your
 actual MongoDB Atlas credentials. Replace `your_voyage_api_key` with
 your key.
 
@@ -190,6 +191,16 @@ cd client
 npm run lint
 ```
 
+## Verify Setup
+
+After completing the setup, run the full verification to ensure everything is configured correctly:
+
+```bash
+./check-requirements-java.sh
+```
+
+This checks your Java environment, Maven dependencies, `.env` configuration, and frontend setup.
+
 ## Issues
 
 If you have problems running the sample app, please check the following:

mflix/README-JAVASCRIPT-EXPRESS.md

@@ -27,6 +27,16 @@ The `sample_mflix` dataset contains movies released up to **2016**. Searching fo
 - **Voyage AI API key** (For MongoDB Vector Search)
   - [Get a Voyage AI API key](https://www.voyageai.com/)
 
+## Verify Requirements
+
+Before getting started, run the verification script to check if you have the required runtime:
+
+```bash
+./check-requirements-js.sh --pre
+```
+
+This checks that Node.js and npm are installed with the correct versions. Run with `--help` for more options.
+
 ## Getting Started
 
 ### 1. Configure the Backend
@@ -61,7 +71,7 @@ NODE_ENV=development
 # CORS Configuration
 # Allowed origin for cross-origin requests (frontend URL)
 # For multiple origins, separate with commas
-CORS_ORIGIN=http://localhost:3000
+CORS_ORIGINS=http://localhost:3000
 
 # Optional: Enable MongoDB Search tests
 # Uncomment the following line to enable Search tests
@@ -210,6 +220,16 @@ cd client
 npm run lint
 ```
 
+## Verify Setup
+
+After completing the setup, run the full verification to ensure everything is configured correctly:
+
+```bash
+./check-requirements-js.sh
+```
+
+This checks your Node.js environment, npm dependencies, `.env` configuration, and frontend setup.
+
 ## Issues
 
 If you have problems running the sample app, please check the following:

mflix/README-PYTHON-FASTAPI.md

@@ -31,6 +31,16 @@ The `sample_mflix` dataset contains movies released up to **2016**. Searching fo
 - **Voyage AI API key** (For MongoDB Vector Search)
   - [Get a Voyage AI API key](https://www.voyageai.com/)
 
+## Verify Requirements
+
+Before getting started, run the verification script to check if you have the required runtime:
+
+```bash
+./check-requirements-python.sh --pre
+```
+
+This checks that Python and pip are installed with the correct versions. Run with `--help` for more options.
+
 ## Getting Started
 
 ### 1. Configure the Backend
@@ -50,21 +60,21 @@ cp .env.example .env
 Edit the `.env` file and set your MongoDB connection string:
 
 ```env
-# MongoDB Configuration
-MONGO_URI=mongodb+srv://<username>:<password>@<cluster>.mongodb.net/sample_mflix?retryWrites=true&w=majority
-MONGO_DB=sample_mflix
+# MongoDB Connection
+MONGODB_URI=mongodb+srv://<username>:<password>@<cluster>.mongodb.net/sample_mflix?retryWrites=true&w=majority
 
-# Voyage AI Configuration
-# API key for Voyage AI embedding model (required for Vector Search)
+# Voyage AI Configuration (optional - required for Vector Search)
 VOYAGE_API_KEY=your_voyage_api_key
 
+# Server Configuration
+PORT=3001
+
 # CORS Configuration
-# Comma-separated list of allowed origins for CORS
-CORS_ORIGINS=http://localhost:3000,http://localhost:3001
+CORS_ORIGINS=http://localhost:3000
 ```
 
-**Note:** Replace `username`, `password`, and `cluster` with your actual MongoDB Atlas
-credentials.
+**Note:** Replace `<username>`, `<password>`, and `<cluster>` with your actual MongoDB Atlas
+credentials. Replace `your_voyage_api_key` with your key.
 
 Make a virtual environment:
 
@@ -196,6 +206,16 @@ cd client
 npm run lint
 ```
 
+## Verify Setup
+
+After completing the setup, run the full verification to ensure everything is configured correctly:
+
+```bash
+./check-requirements-python.sh
+```
+
+This checks your Python environment, dependencies, `.env` configuration, and frontend setup.
+
 ## Issues
 
 If you have problems running the sample app, please check the following: