From 1f2a45b0e0ac6d4ae056745c69f82508ce40e1c9 Mon Sep 17 00:00:00 2001
From: "[esekyi]" <[sskert10@gmail.com]>
Date: Thu, 19 Sep 2024 02:34:12 +0000
Subject: [PATCH] =?UTF-8?q?[Fixes=F0=9F=9B=A0=EF=B8=8F]=20Add=20environmen?=
 =?UTF-8?q?t=20variables=20to=20README.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 5e13a3c..16491df 100644
--- a/README.md
+++ b/README.md
@@ -63,7 +63,26 @@ To run SpiceShare locally, follow these steps:
 	source .venv/bin/activate  # On Windows: .venv\Scripts\activate
 	```
 
-4. Install dependencies:
+4. Create a .env file in the root directory and add these variables
+	```
+	S3_BUCKET_NAME='AWS_S3_bucketName' # for uploads to AWS S3, add your bucket name here
+	AWS_ACCESS_KEY_ID='' # AWS Access key
+	AWS_SECRET_ACCESS_KEY='' # AWS secrete key
+	AWS_REGION='' # AWS region for the S3
+
+	DATABASE_URL='postgresql://postgres:localhost' # Postgress db url
+	SECRET_KEY='WQioiUU-TWIQ-To-Much_TO-6ue22' # Secrete key for Flask and Flsk-WTF
+
+	# Flask-mail variables
+	MAIL_SERVER ='smtp.gmail.com'  # SMTP server address
+	MAIL_PORT =587  # Usually, 465 for SSL or 587 for TLS
+	MAIL_USE_TLS =True  # If you are using port 587 (for TLS), set to True
+	MAIL_USERNAME =''  # Your email address
+	MAIL_PASSWORD =''  # Your email password
+	MAIL_DEFAULT_SENDER ='Your name <your_name@example.com>'
+	```
+
+5. Install dependencies:
 	python and flask
 	```
 	python3 -m pip install -r requirements.txt
@@ -75,12 +94,12 @@ To run SpiceShare locally, follow these steps:
 	yarn install
 	```
 
-5. Set up the database:
+6. Set up the database:
 	```
 	flask db upgrade
 	```
 
-6. Run the application
+7. Run the application
 	```
 	flask db upgrade
 	```