Skip to content

Commit

Permalink
Merge pull request #216 from Arabasta/update-readme
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
Arabasta authored Aug 18, 2024
2 parents 84b3107 + cb1183a commit dc1863a
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Note
This readme is for running the project locally. The deployed version of the project has been taken down as our team is using our
personal AWS accounts and we do not want to incur any further costs.
personal AWS accounts, and we do not want to incur any further costs.

The deployed project was hosted on AWS and used the following services:
- EC2
Expand Down Expand Up @@ -32,7 +32,7 @@ The polygon API key is required for live stock data to run the project. Please s

### Polygon
1. Create an account on Polygon.io
2. Subscribe to the Stock and Crypto APIs
2. Subscribe to the Stock and Crypto APIs, minimum starter package is required.
3. Add your API key to the environment variables

### AWS
Expand All @@ -44,9 +44,7 @@ The polygon API key is required for live stock data to run the project. Please s

#### S3
1. Create a bucket for transactions
2. Create a bucket for predictions
3. Create a bucket for models
4. Add the bucket names to the environment variables
2. Add the bucket names to the spring environment variables

#### SES
1. Go to the SES dashboard
Expand Down Expand Up @@ -80,10 +78,6 @@ AWS_S3_REGION=Your AWS S3 Region

AWS_S3_TRANSACTION_BUCKET_NAME=Your AWS S3 Transaction Bucket Name

AWS_S3_PREDICTION_BUCKET_NAMe=Your AWS S3 Prediction Bucket Name

AWS_S3_MODEL_BUCKET_NAME=Your AWS S3 Model Bucket Name

AWS_SES_ACCESS_KEY_ID=Your AWS SES Access Key

AWS_SES_SECRET_ACCESS_KEY= Your AWS SES Secret Access Key
Expand Down

0 comments on commit dc1863a

Please sign in to comment.