DB, API endpoint, S3, Slack, and payment keys

Below is an example .env.example file and accompanying documentation for local configuration. This includes only the DB, API endpoint, S3, Slack, and payment keys referenced in common/config/main.php. All other configuration keys are marked as optional.

# --- Database Configuration (Placeholder) ---
# These keys are not present in common/config/main.php.
# Set these according to your environment or local DB setup.
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=your_database
DB_USERNAME=your_username
DB_PASSWORD=your_password

# --- API Endpoint Configuration (Placeholder) ---
# Not found in main.php. Set this to your backend API base URL.
API_BASE_URL=http://localhost:8000/api

# --- S3 Configuration (temporaryBucketResourceManager) ---
S3_REGION=eu-west-2
S3_KEY=your_s3_access_key
S3_SECRET=your_s3_secret_key
S3_BUCKET=plugn-public-anyone-can-upload-24hr-expiry

# --- Slack Configuration ---
SLACK_URL=https://hooks.slack.com/services/your/slack/webhook
SLACK_USERNAME=Plugn

SLACK_TAP_OPERATION_URL=https://hooks.slack.com/services/your/tap/operation/webhook
SLACK_TAP_OPERATION_USERNAME=Plugn

SLACK_ERROR_URL=https://hooks.slack.com/services/your/error/webhook
SLACK_ERROR_USERNAME=Plugn

# --- Payment Configuration ---

# Tap Payments
TAP_LIVE_API_KEY=your_tap_live_api_key
TAP_TEST_API_KEY=your_tap_test_api_key
TAP_DESTINATION_ID=your_tap_destination_id

# MyFatoorah Payment
MYFATOORAH_KUWAIT_LIVE_API_KEY=your_kuwait_live_api_key
MYFATOORAH_KUWAIT_TEST_API_KEY=your_kuwait_test_api_key
MYFATOORAH_SAUDI_LIVE_API_KEY=your_saudi_live_api_key

# --- Optional: Other Configuration Keys ---
# The following keys are present in main.php but are not required for most local setups.
# Uncomment and set as needed.

# CLOUDINARY_CLOUD_NAME=plugn
# CLOUDINARY_API_KEY=your_cloudinary_api_key
# CLOUDINARY_API_SECRET=your_cloudinary_api_secret

# IPSTACK_ACCESS_KEY=your_ipstack_access_key
# RECAPTCHA_SECRET_KEY=your_recaptcha_secret_key
# GOOGLE_MAP_TOKEN=your_google_map_token
# NETLIFY_TOKEN=your_netlify_token
# GITHUB_TOKEN=your_github_token
# GITHUB_BRANCH=master

# Additional optional components:
# ARMADA_DELIVERY_KEY=your_armada_delivery_key
# SMS_COMPONENT_KEY=your_sms_component_key
# FILE_GENERATOR_KEY=your_file_generator_key
# MASHKOR_DELIVERY_KEY=your_mashkor_delivery_key
# AUTH0_CLIENT_ID=your_auth0_client_id
# AUTH0_CLIENT_SECRET=your_auth0_client_secret

Notes:

Replace all your_* values with your actual credentials or secrets.
The S3, Slack, and payment keys are directly mapped from the structure in common/config/main.php.
Database and API endpoint keys are placeholders, as they are not defined in main.php and may be set elsewhere in your project.
All other configuration keys in main.php are optional and can be set if your local environment requires them.

# --- Database Configuration (Placeholder) --- # These keys are not present in common/config/main.php. # Set these according to your environment or local DB setup. DB_HOST=localhost DB_PORT=3306 DB_DATABASE=your_database DB_USERNAME=your_username DB_PASSWORD=your_password # --- API Endpoint Configuration (Placeholder) --- # Not found in main.php. Set this to your backend API base URL. API_BASE_URL=http://localhost:8000/api # --- S3 Configuration (temporaryBucketResourceManager) --- S3_REGION=eu-west-2 S3_KEY=your_s3_access_key S3_SECRET=your_s3_secret_key S3_BUCKET=plugn-public-anyone-can-upload-24hr-expiry # --- Slack Configuration --- SLACK_URL=https://hooks.slack.com/services/your/slack/webhook SLACK_USERNAME=Plugn SLACK_TAP_OPERATION_URL=https://hooks.slack.com/services/your/tap/operation/webhook SLACK_TAP_OPERATION_USERNAME=Plugn SLACK_ERROR_URL=https://hooks.slack.com/services/your/error/webhook SLACK_ERROR_USERNAME=Plugn # --- Payment Configuration --- # Tap Payments TAP_LIVE_API_KEY=your_tap_live_api_key TAP_TEST_API_KEY=your_tap_test_api_key TAP_DESTINATION_ID=your_tap_destination_id # MyFatoorah Payment MYFATOORAH_KUWAIT_LIVE_API_KEY=your_kuwait_live_api_key MYFATOORAH_KUWAIT_TEST_API_KEY=your_kuwait_test_api_key MYFATOORAH_SAUDI_LIVE_API_KEY=your_saudi_live_api_key # --- Optional: Other Configuration Keys --- # The following keys are present in main.php but are not required for most local setups. # Uncomment and set as needed. # CLOUDINARY_CLOUD_NAME=plugn # CLOUDINARY_API_KEY=your_cloudinary_api_key # CLOUDINARY_API_SECRET=your_cloudinary_api_secret # IPSTACK_ACCESS_KEY=your_ipstack_access_key # RECAPTCHA_SECRET_KEY=your_recaptcha_secret_key # GOOGLE_MAP_TOKEN=your_google_map_token # NETLIFY_TOKEN=your_netlify_token # GITHUB_TOKEN=your_github_token # GITHUB_BRANCH=master # Additional optional components: # ARMADA_DELIVERY_KEY=your_armada_delivery_key # SMS_COMPONENT_KEY=your_sms_component_key # FILE_GENERATOR_KEY=your_file_generator_key # MASHKOR_DELIVERY_KEY=your_mashkor_delivery_key # AUTH0_CLIENT_ID=your_auth0_client_id # AUTH0_CLIENT_SECRET=your_auth0_client_secret