Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .copier/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"
Expand All @@ -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"
Expand Down
25 changes: 13 additions & 12 deletions mflix/README-JAVA-SPRING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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, you can run the verification script to check if you have all the necessary requirements:

```bash
./check-requirements.sh
```

This script checks for required tools (Java, Maven, Node.js), validates your environment configuration, and verifies dependencies. Run with `--help` for more options.

## Getting Started

### 1. Configure the Backend
Expand All @@ -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.

Expand Down
12 changes: 11 additions & 1 deletion mflix/README-JAVASCRIPT-EXPRESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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, you can run the verification script to check if you have all the necessary requirements:

```bash
./check-requirements.sh
```

This script checks for required tools (Node.js, npm), validates your environment configuration, and verifies dependencies. Run with `--help` for more options.

## Getting Started

### 1. Configure the Backend
Expand Down Expand Up @@ -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
Expand Down
28 changes: 19 additions & 9 deletions mflix/README-PYTHON-FASTAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -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, you can run the verification script to check if you have all the necessary requirements:

```bash
./check-requirements.sh
```

This script checks for required tools (Python, pip, Node.js), validates your environment configuration, and verifies dependencies. Run with `--help` for more options.

## Getting Started

### 1. Configure the Backend
Expand All @@ -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:

Expand Down
Loading