Staging

.env.example

@@ -1,22 +1,136 @@
-# PL Network API
+# PL Network API Configuration
+# ENVIRONMENT: The environment mode for the application.
+# Example: development, staging, or production
+# For local use: development
 ENVIRONMENT=
+
+# PORT: The port on which the server runs.
+# Example: 3000
+# For local use: 3000
 PORT=
 
-# Database configuration
+# Database Configuration
+# DB_HOST_PORT: The port used by the PostgreSQL database.
+# Example: 5432 (default PostgreSQL port)
 DB_HOST_PORT=
+
+# DB_USER: The username for connecting to the PostgreSQL database.
+# Example: postgres
 DB_USER=
+
+# DB_PASSWORD: The password for the PostgreSQL database user.
+# Example: mysecurepassword
 DB_PASSWORD=
+
+# DB_NAME: The name of the PostgreSQL database.
+# Example: pl-dev-db
 DB_NAME=
+
+# DATABASE_URL: The connection string for the PostgreSQL database.
+# Format: "postgres://username:password@host:port/database"
+# Example: "postgres://postgres:mysecurepassword@localhost:5432/pl-dev-db"
 DATABASE_URL=
 
-# Redis
+# Redis Configuration
+# REDIS_HOST: The hostname or IP address of the Redis server.
+# Example: localhost or redis-server
 REDIS_HOST=
+
+# REDIS_PORT: The port on which the Redis server runs.
+# Example: 6379 (default Redis port)
 REDIS_PORT=
 
+# Google APIs
+# GOOGLE_PLACES_API_KEY: The API key for accessing Google Places.
+# Set any valid Google Places API key for local use.
+GOOGLE_PLACES_API_KEY=
+
+# Authentication Configuration
+# AUTH_API_URL: The endpoint URL for the authentication API.
+# For local use: https://sandbox-auth.plnetwork.io
+AUTH_API_URL=
+
+# AUTH_APP_CLIENT_SECRET: The client secret for the authentication application.
+# Set any random string for local use. 
+AUTH_APP_CLIENT_SECRET=
+
+# AUTH_APP_CLIENT_ID: The client ID for the authentication application.
+# Set any random string for local use. 
+AUTH_APP_CLIENT_ID=
+
+# WEB_UI_BASE_URL: The base URL for the web application.
+# For local use: http://localhost:4200
+WEB_UI_BASE_URL=
+
+# LOGIN_REDIRECT_URL: The URL path for redirecting after login.
+# For local use: directory/members/verify-member
+LOGIN_REDIRECT_URL=
+
+# GitHub API
+# GITHUB_API_KEY: The API key for accessing GitHub data.
+# Github personal access token
+GITHUB_API_KEY=
+
+# Admin Configuration
+# ADMIN_TOKEN_SECRET: The secret used to generate admin tokens.
+# For local use set any secure random string
+ADMIN_TOKEN_SECRET=
+
+# AWS S3 Configuration
+# AWS_ACCESS_KEY: The AWS access key for S3.
+AWS_ACCESS_KEY=
+
+# AWS_SECRET_KEY: The AWS secret key for S3.
+AWS_SECRET_KEY=
+
+# AWS_REGION: The AWS region where the S3 bucket is located.
+# Ex: us-west-1
+AWS_REGION=
+
+# AWS_S3_BUCKET_NAME: The name of the S3 bucket for storing files.
+# Ex: pl-events-service
+AWS_S3_BUCKET_NAME=
+
+# AWS_S3_DOMAIN: The domain name for accessing the S3 bucket.
+# Ex: s3.amazonaws.com
+AWS_S3_DOMAIN=
+
+# Email Configuration
+# IS_EMAIL_ENABLED: Toggle for enabling or disabling email functionality.
+# Make sure it should be false for local development
+IS_EMAIL_ENABLED=
+
+# Env variables for Back Office
+#---------------------------------#
+
+# Directory Backend API URL
+# For local development, use: http://localhost:<PORT>, where PORT is the env variable configured above.
+# eg. http://localhost:3000, where PORT=3000
+WEB_API_BASE_URL=
+
+# Back Office Application Login Username
+# For local development, use: admin
+ADMIN_LOGIN_USERNAME=
+
+# Back Office Application Login Password
+# For local development, use: admin
+ADMIN_LOGIN_PASSWORD=
+
+
+
+# Optional for local development
+
 # Error Reporting
 SENTRY_DSN=
 
+# Airtable
+AIRTABLE_API_KEY=
+AIRTABLE_BASE_ID=
+AIRTABLE_TEAMS_TABLE_ID=
+AIRTABLE_MEMBERS_TABLE_ID=
+
 # File Encryption
+FILE_STORAGE=
 FILE_ENCRYPTION_ALGORITHM=
 FILE_ENCRYPTION_PASSWORD=
 FILE_ENCRYPTION_SALT=
@@ -28,47 +142,58 @@ WORKER_IMAGE_URL=
 # Web3 File Storage
 WEB3_STORAGE_API_TOKEN=
 
-# Web API
-WEB_API_BASE_URL=
-
-# Forest Admin
+# Forest Admin API keys
 FOREST_ENV_SECRET=
 FOREST_AUTH_SECRET=
 
+# Hightouch API
 HIGHTOUCH_API_KEY=
 
-# Google APIs
-GOOGLE_PLACES_API_KEY=
-
-# login redirect url 
-LOGIN_REDIRECT_URL=
+# Google Recaptcha
+GOOGLE_SITE_KEY=
+GOOGLE_RECAPTCHA_SECRET=
 
 # Cloudflare login url
 LOGIN_URL=
 
 # Interval to check whether expired token is expired
 NEXT_PUBLIC_TOKEN_EXPIRY_CHECK_IN_MINUTES= // in minutes
 
-#Announcement banner json fetch token
-ANNOUNCEMENT_S3_AUTH_TOKEN=
+# SES Admin emails
+SES_SOURCE_EMAIL=
+SES_ADMIN_EMAIL_IDS=
+SUPPORT_EMAILS=
 
-#Cookie domain
-COOKIE_DOMAIN= // domain
+# SLACK
+CHANNEL_ID=
+SLACK_BOT_TOKEN=
 
-FILE_STORAGE=
+# AWS Cloud watch 
+CLOUDWATCH_GROUP_NAME=
+CLOUDWATCH_ACCESS_KEY=
+CLOUDWATCH_SECRET_KEY=
+CLOUDWATCH_REGION=
 
-AWS_S3_BUCKET_NAME= 
+# Announcement banner json fetch token
+ANNOUNCEMENT_S3_AUTH_TOKEN=
 
-AWS_S3_DOMAIN=
+# Cookie domain
+COOKIE_DOMAIN=
+
+# File storage for image (IPFS or AWS)
+FILE_STORAGE=
 
-// no of days delay the follow up for interaction
+# No of days delay the follow up for interaction
 INTERACTION_FOLLOWUP_DELAY_IN_DAYS=
 
-// no of milliseconds delay in between interacitons
+# No of milliseconds delay in between interactions
 INTERACTION_INTERVAL_DELAY_IN_MILLISECONDS=
 
-// no of days to decide recent record
+# Number of days to determine if records (teams, members, projects) are considered recent
+# Example: 30 (indicating records from the last 30 days will be treated as recent)
 RECENT_RECORD_DURATION_IN_DAYS=
 
-// internal auth token
-INTERNAL_AUTH_TOKEN=
+# Authentication token for secure communication between internal services (e.g., events service)
+INTERNAL_AUTH_TOKEN=
+
+