Environment Variables
Each repo ships an .env.*.example file. Copy and fill in values before running.
django-api
cp .env.development.example .env.development
| Variable | Description |
|---|---|
DJANGO_SETTINGS_MODULE | e.g. config.settings.local |
SECRET_KEY | Django secret key |
DATABASE_URL | MySQL DSN |
CELERY_BROKER_URL | Redis URL |
CELERY_RESULT_BACKEND | Redis URL |
AWS_ACCESS_KEY_ID | S3 credentials |
AWS_SECRET_ACCESS_KEY | S3 credentials |
AWS_STORAGE_BUCKET_NAME | S3 bucket |
DJANGO_EMAIL_BACKEND | Email backend class (see Mail service) |
EMAIL_HOST | SMTP host — mailpit for local/staging, real host for production |
EMAIL_PORT | SMTP port — 1025 for Mailpit, 587 for TLS |
EMAIL_HOST_USER | SMTP username (empty for Mailpit) |
EMAIL_HOST_PASSWORD | SMTP password (empty for Mailpit) |
EMAIL_USE_TLS | True for production SMTP, False for Mailpit |
EMAIL_USE_SSL | True only if provider requires SSL on port 465 |
SENDGRID_API_KEY | Required only when DJANGO_EMAIL_BACKEND=anymail...sendgrid |
CLEARCHECKS_API_KEY | Background check API |
RECAPTCHA_SECRET_KEY | Google ReCaptcha v3 |
ALLOWED_HOSTS | Comma-separated hostnames |
CORS_ALLOWED_ORIGINS | Comma-separated SPA origins |
portals
cp .env.development.example .env.development
| Variable | Description |
|---|---|
VITE_API_BASE_URL | django-api base URL |
VITE_RECAPTCHA_SITE_KEY | Google ReCaptcha v3 site key |
testing
cp apps/novahomecare/.env.development.example apps/novahomecare/.env.development
| Variable | Description |
|---|---|
CYPRESS_BASE_URL | Portals SPA URL under test |
CYPRESS_API_URL | django-api URL under test |
CYPRESS_ADMIN_EMAIL / _PASSWORD | Admin test credentials |
CYPRESS_EMPLOYEE_EMAIL / _PASSWORD | Employee test credentials |
CYPRESS_MARKETER_EMAIL / _PASSWORD | Marketer test credentials |
Never commit secrets
Keep all .env.* files in .gitignore. Use your team's secret manager for sharing credentials.