459 add definitions for important env variables to readme

README.md

@@ -110,6 +110,54 @@ server {
 ``cd ~/bluewave-onboarding
 docker compose up -d``
 
+## Environment variables
+
+In order to the project to run safely and correctly, the user should add their own environment variables. They can be added to the .env file in the root directory of the project. The following is the list of environment variables that should be added and its description:
+
+1. Database credentials
+```
+DEV_DB_USERNAME - Development database username
+DEV_DB_PASSWORD - Development database password
+DEV_DB_NAME - Development database name
+DEV_DB_HOST - Development database host
+DEV_DB_PORT - Development database port
+TEST_DB_USERNAME - Test database username
+TEST_DB_PASSWORD - Test database password
+TEST_DB_NAME - Test database name
+TEST_DB_HOST - Test database host
+TEST_DB_PORT - Test database port
+PROD_DB_USERNAME - Production database username
+PROD_DB_PASSWORD - Production database password
+PROD_DB_NAME - Production database name
+PROD_DB_HOST - Production database host
+PROD_DB_PORT - Production database port
+```
+
+2. Email service configuration
+For the email service to run correctly, the user should add their own email credentials
+```
+EMAIL_ENABLE - Enable email service (boolean)
+EMAIL_HOST - Email host
+EMAIL_PORT - Email port
+EMAIL - Email
+APP_PASSWORD - Email password
+```
+
+3. JWT Secret Key
+```
+JWT_SECRET - secret key to sign the JWT token
+```
+
+4. Enable IP check for the API
+If the ENABLE_IP_CHECK is set to true, but the ALLOWED_IP_RANGE and ALLOWED_IPS are not set, the API will work for all IP addresses.
+```
+ENABLE_IP_CHECK - Enable IP check for the API (boolean)
+ALLOWED_IP_RANGE - Allowed IP range for the API with the format "baseIp/rangeStart-rangeEnd" (e.g. 192.168.1/1-255) separated by comma
+ALLOWED_IPS - Allowed IP addresses for the API separated by comma
+```
+
+For development and testing purposes, the application is ready to go after cloning and dependencies installation.
+
 ## Contributing
 
 Here's how you can contribute to the Onboarding product. 

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