|
| 1 | +# Nonprofit Social Networking Platform: Allowing Users and Organizations to Collaborate. |
| 2 | +# Copyright (C) 2023 ASCENDynamics NFP |
| 3 | +# |
| 4 | +# This file is part of Nonprofit Social Networking Platform. |
| 5 | +# |
| 6 | +# Nonprofit Social Networking Platform is free software: you can redistribute it and/or modify |
| 7 | +# it under the terms of the GNU Affero General Public License as published |
| 8 | +# by the Free Software Foundation, either version 3 of the License, or |
| 9 | +# (at your option) any later version. |
| 10 | +# |
| 11 | +# Nonprofit Social Networking Platform is distributed in the hope that it will be useful, |
| 12 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | +# GNU Affero General Public License for more details. |
| 15 | +# |
| 16 | +# You should have received a copy of the GNU Affero General Public License |
| 17 | +# along with Nonprofit Social Networking Platform. If not, see <https://www.gnu.org/licenses/>. |
| 18 | + |
| 19 | +# ============================================================================= |
| 20 | +# .env.example — copy to .env.development and .env.production, then fill in. |
| 21 | +# ============================================================================= |
| 22 | +# Both files are gitignored. This template is committed so forks know exactly |
| 23 | +# which variables are required. |
| 24 | +# |
| 25 | +# Quick-start for a new fork: |
| 26 | +# 1. Copy this file twice: |
| 27 | +# cp .env.example .env.development |
| 28 | +# cp .env.example .env.production |
| 29 | +# 2. Fill in every value below (dev and prod may share some keys). |
| 30 | +# 3. Set your bundle ID once: |
| 31 | +# npm run set-bundle-id -- com.yourorg.yourapp |
| 32 | +# 4. Register the new bundle ID as an Android / iOS app in Firebase console |
| 33 | +# and replace android/app/google-services.json (and ios GoogleService-Info.plist |
| 34 | +# once you add the iOS platform). |
| 35 | +# 5. Run the dev server: npm start |
| 36 | +# ============================================================================= |
| 37 | + |
| 38 | +# ----------------------------------------------------------------------------- |
| 39 | +# Firebase project credentials |
| 40 | +# Get these from Firebase console → Project settings → Your apps → Web app. |
| 41 | +# ----------------------------------------------------------------------------- |
| 42 | +FIREBASE_API_KEY= |
| 43 | +FIREBASE_AUTH_DOMAIN= |
| 44 | +FIREBASE_DATABASE_URL= |
| 45 | +FIREBASE_PROJECT_ID= |
| 46 | +FIREBASE_STORAGE_BUCKET= |
| 47 | +FIREBASE_MESSAGING_SENDER_ID= |
| 48 | +FIREBASE_APP_ID= |
| 49 | +FIREBASE_MEASUREMENT_ID= |
| 50 | +FIREBASE_API_URL= |
| 51 | + |
| 52 | +# ----------------------------------------------------------------------------- |
| 53 | +# Google Maps |
| 54 | +# Create an API key at https://console.cloud.google.com → APIs & Services. |
| 55 | +# Enable: Maps JavaScript API, Geocoding API, Places API. |
| 56 | +# ----------------------------------------------------------------------------- |
| 57 | +GOOGLE_MAPS_API_KEY= |
| 58 | + |
| 59 | +# ----------------------------------------------------------------------------- |
| 60 | +# Google Sign-In OAuth client IDs |
| 61 | +# Create at https://console.cloud.google.com → APIs & Services → Credentials. |
| 62 | +# Web client: OAuth 2.0 client, type = Web application |
| 63 | +# Android client: OAuth 2.0 client, type = Android (requires SHA-1 fingerprint) |
| 64 | +# ----------------------------------------------------------------------------- |
| 65 | +GOOGLE_AUTH_WEB_CLIENT_ID= |
| 66 | +GOOGLE_AUTH_ANDROID_CLIENT_ID= |
| 67 | + |
| 68 | +# ----------------------------------------------------------------------------- |
| 69 | +# Public-facing base URL for SEO / structured data (no trailing slash). |
| 70 | +# Used in meta tags, Open Graph URLs, canonical links, JSON-LD. |
| 71 | +# Example: https://yourfork.example.com |
| 72 | +# ----------------------------------------------------------------------------- |
| 73 | +APP_BASE_URL= |
| 74 | + |
| 75 | +# ----------------------------------------------------------------------------- |
| 76 | +# Branding / static site copy. |
| 77 | +# These are substituted into src/index.html, src/funding.json, the legal modal, |
| 78 | +# and the terms-of-use page at build time by generate-env.js. |
| 79 | +# ----------------------------------------------------------------------------- |
| 80 | +# Full display title used in <title>, og:title, twitter:title, funding.json. |
| 81 | +APP_NAME=Your Co-op Platform |
| 82 | +# Single-sentence description used in <meta description>, og:description, etc. |
| 83 | +APP_DESCRIPTION=An open-source collaboration platform for cooperatives and nonprofits. |
| 84 | +# General/support contact address (terms of use, funding manifest, legal modal). |
| 85 | +SUPPORT_EMAIL=support@example.org |
| 86 | +# Privacy contact address (privacy policy section of the legal modal). |
| 87 | +PRIVACY_EMAIL=privacy@example.org |
| 88 | + |
| 89 | +# ----------------------------------------------------------------------------- |
| 90 | +# Organization identity used by the legal modal (privacy policy & terms of use). |
| 91 | +# These appear verbatim in the legal text — leave blank to omit a line. |
| 92 | +# ----------------------------------------------------------------------------- |
| 93 | +# Physical mailing address (single line, displayed in the "Contact" section). |
| 94 | +# NOTE: quote any value containing '#' so dotenv doesn't treat it as a comment. |
| 95 | +ORG_MAILING_ADDRESS="123 Example Street #4, City, State, Country 00000" |
| 96 | +# Public phone number (display-only; format however you want). |
| 97 | +ORG_PHONE= |
| 98 | +# Community/support channel URL (Slack, Discord, forum, etc.). Leave blank to hide. |
| 99 | +ORG_COMMUNITY_URL= |
| 100 | +# Governing-law jurisdiction referenced in the Terms of Use. |
| 101 | +ORG_JURISDICTION=State of Example, Country |
| 102 | +# Effective date for the published privacy policy / terms of use. |
| 103 | +LEGAL_EFFECTIVE_DATE=January 1, 2025 |
| 104 | + |
| 105 | +# ----------------------------------------------------------------------------- |
| 106 | +# Build-time brand defaults (optional). |
| 107 | +# |
| 108 | +# These values are baked into the JS bundle and become the first-paint identity |
| 109 | +# for THIS deployment — they apply even when the user is offline on first visit |
| 110 | +# (before Firebase Remote Config has ever fetched). Firebase Remote Config and |
| 111 | +# per-device localStorage overrides still take precedence at runtime. |
| 112 | +# |
| 113 | +# Leave a value BLANK to inherit the upstream ASCENDynamics NFP default for |
| 114 | +# that field. Set every value to ship a fully white-labeled offline-first build. |
| 115 | +# |
| 116 | +# Tagline: NOTE — quote this in your .env file when it contains '#' or '='. |
| 117 | +# Colors: CSS hex, e.g. #1565c0. Logo: absolute https:// URL, leave blank for |
| 118 | +# text-only. |
| 119 | +# ----------------------------------------------------------------------------- |
| 120 | +BRAND_APP_NAME= |
| 121 | +BRAND_TAGLINE= |
| 122 | +BRAND_LOGO_URL= |
| 123 | +BRAND_PRIMARY_COLOR= |
| 124 | +BRAND_SECONDARY_COLOR= |
0 commit comments