PokeGoBreeze/.env.example at main · WHIZENx/PokeGoBreeze · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# PokeGoBreeze Environment Variables
# Copy this file to .env and fill in your actual values
# NOTE: Never commit .env file to version control

# ====================
# GitHub & Repository
# ====================

# Optional GitHub token for private repository access.
# Public GitHub APIs used by the app do not need this value.
REACT_APP_TOKEN_PRIVATE_REPO=

# ====================
# Vercel Edge Config
# ====================

# Vercel Edge Config Write Token (used by deploy.sh)
REACT_APP_EDGE_TOKEN=your_edge_write_token_here

# Vercel Edge Config Read Token (used by config.sh)
REACT_APP_EDGE_READ_TOKEN=your_edge_read_token_here

# Vercel Edge Config ID (e.g. ecfg_xxx)
REACT_APP_EDGE_ID=ecfg_your_edge_config_id_here

# ====================
# Security & Encryption
# ====================

# Encryption key for secure data storage (use a strong random string, 40+ characters)
REACT_APP_ENCRYPTION_KEY=your_strong_encryption_key_here

# Encryption salt for additional security (use a strong random string, 40+ characters)
REACT_APP_ENCRYPTION_SALT=your_strong_encryption_salt_here

# ====================
# Application Configuration
# ====================

# Deployment mode: development | staging | production
REACT_APP_DEPLOYMENT_MODE=development

# Application base URL
REACT_APP_BASE_URL=your_app_base_url

# Local processed-data API (used by Docker Compose and local Vite)
REACT_APP_DATA_API_URL=http://localhost:3001

# App version (e.g. 1.0.0)
# Empty means it will use .github/workflows/deploy.yml version
REACT_APP_VERSION=1.0.0

# Redux DevTools verbosity (development only)
# true  = show full store data in Redux DevTools
# false = show only item counts (default, recommended for large datasets)
REACT_APP_REDUX_VERBOSE=false

# ====================
# Mongo Database
# ====================

# MongoDB connection string (used by deploy.sh to record version history)
MONGODB_URI=mongodb+srv://user:password@cluster.mongodb.net/?retryWrites=true&w=majority

# ====================
# Development Notes
# ====================
#
# To use these variables:
# 1. Copy this file: cp .env.example .env
# 2. Fill in your actual values
# 3. Never commit the .env file to git
# 4. Restart development server after changes
#
# For Docker, run `npm run docker:up` from PokeGoBreeze-workspace.
#
# For production deployment:
# - Set these variables as GitHub Actions secrets
# - Set REACT_APP_* variables in Vercel project settings
#
# Security Notes:
# - ENCRYPTION_KEY and ENCRYPTION_SALT should be long, random strings
# - Never share authentication tokens or API keys publicly
# - Rotate keys regularly for security best practices