.env.example

# ============================================
# Help2Study - Environment Variables
# ============================================
# WHAT ARE ENVIRONMENT VARIABLES?
# These are configuration values stored OUTSIDE your code.
# They keep sensitive data (like API keys) secure and make
# your app portable across different environments.
#
# WHY USE THEM?
# ✓ Security: Never commit secrets to Git
# ✓ Flexibility: Different values for dev/production
# ✓ Portability: Same code works everywhere
#
# HOW TO USE THIS FILE:
# 1. Copy this file: cp .env.example .env
# 2. Fill in your actual values in .env
# 3. Never commit .env to Git (it's in .gitignore)
# ============================================

# --------------------------------------------
# Backend Configuration (Django)
# --------------------------------------------

# Gemini API Key (REQUIRED)
# This powers the AI flashcard generation feature
# Get your free API key: https://makersuite.google.com/app/apikey
API_KEY=your_gemini_api_key_here

# Django Secret Key (REQUIRED for production)
# Used for cryptographic signing (sessions, passwords, etc.)
# Generate one: python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'
# SECURITY: Change this before deploying to production!
# SECRET_KEY=your-secret-key-here

# Debug Mode (REQUIRED for production)
# Set to False in production for security
# Default: True (only for development)
# DEBUG=False

# Allowed Hosts (REQUIRED for production)
# Comma-separated list of domains that can access your app
# Example: ALLOWED_HOSTS=yourdomain.com,www.yourdomain.com,localhost
# ALLOWED_HOSTS=localhost,127.0.0.1

# Database URL (OPTIONAL - defaults to SQLite)
# For production, use PostgreSQL
# Format: postgresql://username:password@host:port/database
# DATABASE_URL=postgresql://user:password@localhost:5432/help2study

# --------------------------------------------
# Frontend Configuration (React/Vite)
# --------------------------------------------

# Backend API URL (REQUIRED)
# Where the frontend sends requests
# Development: http://localhost:8000
# Production: https://your-api-domain.com
# IMPORTANT: Do NOT use quotes around the URL
VITE_API_URL=http://localhost:8000

# --------------------------------------------
# Optional: Advanced Configuration
# --------------------------------------------

# CORS Origins (OPTIONAL)
# Which domains can make requests to your API
# CORS_ALLOWED_ORIGINS=http://localhost:5173,http://localhost:3000

# Port Configuration (OPTIONAL)
# BACKEND_PORT=8000
# FRONTEND_PORT=5173