459 add definitions for important env variables to readme

backend/.env

@@ -1,24 +1,27 @@
+# For development environment, the project is ready to run after cloning and installing the dependencies.
+
 # Node environment
 NODE_ENV=development
 
-# Development environment
+# Development database environment
 DEV_DB_USERNAME=user123
 DEV_DB_PASSWORD=password123
 DEV_DB_NAME=onboarding_db
 DEV_DB_HOST=db
 DEV_DB_PORT=5432
 
+# Enable email service
 EMAIL_ENABLE=false
+# Email service configuration, for the email service to run correctly, the user should add their own email credentials
+EMAIL_HOST=your_email_host
+EMAIL_PORT=your_email_port
+EMAIL=your_email
+APP_PASSWORD=your_app_password
 
 # JWT Secret Key
 JWT_SECRET="NKrbO2lpCsOpVAlqAPsjZ0tZXzIoKru7gAmYZ7XlHn0=qqwqeq"
 
-TEST_DB_USERNAME=user123
-TEST_DB_PASSWORD=password123
-TEST_DB_NAME=onboarding_db_test
-TEST_DB_HOST=localhost
-TEST_DB_PORT=5432
-
+# Enable IP check for the API
 ENABLE_IP_CHECK=false
 # Allowed IP range for the API "baseIp/rangeStart-rangeEnd" (e.g. 192.168.1/1-255) separated by comma
 ALLOWED_IP_RANGE=11.22.33/10-200, 192.168.65/1-255

backend/.env.production

@@ -1,15 +1,22 @@
-# Production Environment Configuration
-
-# Database Configuration
-PROD_DB_USERNAME=prod_user
-PROD_DB_PASSWORD=prod_password
-PROD_DB_NAME=prod_db
-PROD_DB_HOST=localhost
+# Production environment
+PROD_DB_USERNAME=user123
+PROD_DB_PASSWORD=password123
+PROD_DB_NAME=onboarding_db
+PROD_DB_HOST=db
 PROD_DB_PORT=5432
 
+# Enable email service
+EMAIL_ENABLE=true
+# Email service configuration, for the email service to run correctly, the user should add their own email credentials
+EMAIL_HOST=your_email_host
+EMAIL_PORT=your_email_port
+EMAIL=your_email
+APP_PASSWORD=your_app_password
+
 # JWT Secret Key
 JWT_SECRET=your_prod_jwt_secret_key_here
 
+# Enable IP check for the API
 ENABLE_IP_CHECK=false
 # Allowed IP range for the API "baseIp/rangeStart-rangeEnd" (e.g. 192.168.1/1-255) separated by comma
 ALLOWED_IP_RANGE=11.22.33/10-200

backend/.env.test

@@ -1,19 +1,21 @@
 # Test Environment Configuration
 
-# Database Configuration
+# Test database environment
 TEST_DB_USERNAME=user123
 TEST_DB_PASSWORD=password123
 TEST_DB_NAME=onboarding_db_test
 TEST_DB_HOST=localhost
 TEST_DB_PORT=5432
 
+# Credentials for test postgres database
 POSTGRES_USER=user123
 POSTGRES_PASSWORD=password123
 POSTGRES_DB=onboarding_db_test
 
 # JWT Secret Key
 JWT_SECRET=your_test_jwt_secret_key_here
 
+# Enable IP check for the API
 ENABLE_IP_CHECK=false
 # Allowed IP range for the API "baseIp/rangeStart-rangeEnd" (e.g. 192.168.1/1-255) separated by comma
 ALLOWED_IP_RANGE=11.22.33/10-200, 192.168.65/1-255