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
24 changes: 24 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,34 @@ If you're unsure whether your idea falls into the preview category, feel free to
UPSTASH_REDIS_REST_URL="http://localhost:8079"
UPSTASH_REDIS_REST_TOKEN="example_token"

# Marble Blog (example organization key - optional for local development)
MARBLE_WORKSPACE_KEY=cm6ytuq9x0000i803v0isidst
NEXT_PUBLIC_MARBLE_API_URL=https://api.marblecms.com

# Development
NODE_ENV="development"
```

**Optional Variables (for advanced features):**

```bash
# Freesound API (for audio library feature)
# Get credentials at https://freesound.org/apiv2/apply/
FREESOUND_CLIENT_ID=...
FREESOUND_API_KEY=...

# Cloudflare R2 (for auto-captions/transcription feature)
# Get these from Cloudflare Dashboard > R2 > Manage R2 API tokens
CLOUDFLARE_ACCOUNT_ID=your-account-id
R2_ACCESS_KEY_ID=your-access-key-id
R2_SECRET_ACCESS_KEY=your-secret-access-key
R2_BUCKET_NAME=opencut-transcription

# Modal transcription endpoint (from modal deploy transcription.py)
# See apps/transcription/README.md for setup instructions
MODAL_TRANSCRIPTION_URL=https://your-username--opencut-transcription-transcribe-audio.modal.run
```

**Generate BETTER_AUTH_SECRET:**

```bash
Expand Down
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,20 +108,40 @@ Before you begin, ensure you have the following installed on your system:

# Generate a secure secret for Better Auth
BETTER_AUTH_SECRET="your-generated-secret-here"
BETTER_AUTH_URL="http://localhost:3000"
NEXT_PUBLIC_BETTER_AUTH_URL="http://localhost:3000"

# Redis (matches docker-compose.yaml)
UPSTASH_REDIS_REST_URL="http://localhost:8079"
UPSTASH_REDIS_REST_TOKEN="example_token"

# Marble Blog
MARBLE_WORKSPACE_KEY=cm6ytuq9x0000i803v0isidst # example organization key
# Marble Blog (example organization key - optional for local development)
MARBLE_WORKSPACE_KEY=cm6ytuq9x0000i803v0isidst
NEXT_PUBLIC_MARBLE_API_URL=https://api.marblecms.com

# Development
NODE_ENV="development"
```

**Optional Variables (for advanced features):**

```bash
# Freesound API (for audio library feature)
# Get credentials at https://freesound.org/apiv2/apply/
FREESOUND_CLIENT_ID=...
FREESOUND_API_KEY=...

# Cloudflare R2 (for auto-captions/transcription feature)
# Get these from Cloudflare Dashboard > R2 > Manage R2 API tokens
CLOUDFLARE_ACCOUNT_ID=your-account-id
R2_ACCESS_KEY_ID=your-access-key-id
R2_SECRET_ACCESS_KEY=your-secret-access-key
R2_BUCKET_NAME=opencut-transcription

# Modal transcription endpoint (from modal deploy transcription.py)
# See apps/transcription/README.md for setup instructions
MODAL_TRANSCRIPTION_URL=https://your-username--opencut-transcription-transcribe-audio.modal.run
```

**Generate BETTER_AUTH_SECRET:**

```bash
Expand Down
2 changes: 1 addition & 1 deletion apps/transcription/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ pip install -r requirements.txt

> If you don't know what Modal is: it allows us to process the actual audio and transcribe with Whisper by providing the infra to run Python code with a lot of RAM, generally affordable.

5. Once you've got a Modal accoumt, run this:
5. Once you've got a Modal account, run this:

```bash
python -m modal setup
Expand Down