docs: update 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.