Merge pull request #218 from Arabasta/update-readme

docs: update readme

README.md

@@ -14,7 +14,11 @@ The deployed project was hosted on AWS and used the following services:
 This version of the project only uses 5 tickers and models for prediction by the FastAPI server. The deployed version of
 the project used 502 tickers and models for prediction.
 
-There is no way to emulate S3 and SES locally, please sign up for an AWS account and use the services to run the project.
+There is no way to emulate S3 locally, please sign up for an AWS account and create a bucket for the trading algorithms transactions
+to run the project.
+
+All other AWS services are set to false in the Spring boot application properties file. 
+Please set them to true if you want to use them, creating the AWS resources is required for the project to run when set to true.
 
 The polygon API key is required for live stock data to run the project. Please sign up for an account and use the API key to run the project.
 
@@ -25,10 +29,12 @@ The polygon API key is required for live stock data to run the project. Please s
 - AWS
 - Polygon API Key (Stock and Crypto)
 - Expo
+- Node.js
 - React Native
 - React
 - npm
 - FastAPI
+- Android Studio
 
 ### Polygon
 1. Create an account on Polygon.io
@@ -37,31 +43,35 @@ The polygon API key is required for live stock data to run the project. Please s
 
 ### AWS
 
-#### Access Keys
-1. Create a S3 Access Key and Secret Access Key
-2. Create an SES Access Key and Secret Access Key
-3. Add the access keys to the environment variables
-
 #### S3
-1. Create a bucket for transactions
-2. Add the bucket names to the spring environment variables
-
-#### SES
-1. Go to the SES dashboard
-2. Under Configuration > Identities, click Create Identity
-3. Add your Email Address and Domain
-4. Verify your email address
-5. Click the Get setup button and Request AWS for production access
-6. Add your sender email address to the environment variables
+1. Create a S3 Access Key and Secret Access Key
+2. Create a bucket for transactions
+3. Add the bucket name and access keys to the spring environment variables
 
 ### Spring
 1. Install JDK 17
 2. Install Maven
 3. Add your JWT Secret Key to the environment variables
 4. Set the configuration for the database
-5. Set the AWS configurations to false if you do not want to use AWS
+5. Set the AWS configurations in application.properties to true if you want to use AWS
+6. AWS S3 transactions bucket is required for the project to run
 
 ### FastAPI
 Please refer to /back/fastapi/README.md for instructions on how to run the FastAPI server
 
+### React Native
+Please refer to /mobile/react-native-expo/README.md for instructions on how to run the React Native app
+
+
+## Additional AWS Services (set to false in application.properties)
 
+#### SES
+1. Go to the SES dashboard
+2. Under Configuration > Identities, click Create Identity
+3. Add your Email Address and Domain
+4. Verify your email address
+5. Click the Get setup button and Request AWS for production access
+6. Add your sender email address to the environment variables
+7. Set the SES configuration in application.properties to true if you want to use SES
+8. Create an access key and secret access key for the IAM user with SES permissions
+9. Add the access key and secret access key to the environment variables

back/spring/src/main/resources/application.properties

@@ -28,4 +28,4 @@ s3.transaction_logging.enabled=false
 sns.notifications.enabled=false
 
 # AWS SES requires verified domain to send emails outside of sandbox mode
-ses.notifications.enabled=true
+ses.notifications.enabled=false

mobile/react-native-expo/README.md

@@ -1,11 +1,20 @@
 # Starting Expo
 
-### Android Studio
+### Installation
+
+Install Node.js and npm from the official website.
+
+Install Expo CLI globally using npm:
+```bash
+npm install -g expo-cli
+```
 
+Follow the instructions in the [React Native](https://reactnative.dev/docs/environment-setup) 
+documentation to install the required dependencies for React Native.
 
-Open Android Studio, open Device Manager and run the Android emulator, ~~or open Xcode and run the iOS simulator~~.
 
-Using Pixel 8 API 29 Q
+### Android Studio
+Open Android Studio, open Device Manager and run the Android emulator - Pixel 8 API 29 Q.
 
 ### WebStorm