Any important project credentials will be stored in wordvision_credentials.txt or alternatively in .env.txt in our PRJ666 Team 1 folder.

Determining the points/estimates typically involves reviewing the number of tasks and how long it takes to accomplish a task.

• 1 pt - story needs at least 1 day, max 2 days.
• 3 pts - story needs at least 2 days, max 3 days.
• 5 pts - story needs at least 3 days, max 4 days.
• 8 pts - story may take up a whole sprint or longer.

Perform the following steps when working on an assigned task:

1. Move task to "In Progress"
2. Create a development branch based on the task. Use the format <issue no.>-<task name in all lowercase with words separated by dash> when creating the branch name (Example: 100-sample-task). Link this development branch to your task. You can easily do this by going to your issue, go to the "Development" category, and choosing "Create a branch"

3. Make changes to the branch.
4. Test your changes.
5. When all is working, switch to the main branch and pull its changes.
6. Switch back to your issue branch and merge main INTO your issue branch.
7. Resolve conflicts, if any.
8. Commit your local branch changes and push to remote repo on github.
9. Once pushed, go to your branch on GitHub and create a pull request with at least one person to review.
10. Move task to "Ready for Review".
11. Once approved, merge your changes INTO main branch. (it is recommended that the one who opened the pull request merges it, but anyone can do it if needed)
12. Once merged with no conflicts, delete the branch and move task to "Done"

This ensures that everyone is able to track the the status of tasks and reduces the chance of merge conflicts. This also helps to ensure that code is peer-reviewed first before merging into the main branch.

• Install AWS CLI by following this guide https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
• Once AWS CLI is installed, run aws configure to configure the cli with our wordvision credentials found in our wordvision_credentials.txt

  $ aws configure
  AWS Access Key ID [None]: <refer to our credentials file>
  AWS Secret Access Key [None]: <refer to our credentials file>
  Default region name [None]: us-east-1
  Default output format [None]: json
  

• AWS CLI is now setup

If you want to test any of the authenticated endpoints, you need the id token for a logged-in user. In order to log into a user and get their tokens, you can run this command using the AWS CLI. (replace <user email> and <password> with the actual email and password) NOTE: AWS CLI must be setup before you can run this.

aws cognito-idp initiate-auth --auth-flow USER_PASSWORD_AUTH --client-id 5nlgr8qrqjocvvg9o2sfrqnr5r --auth-parameters USERNAME=<user email>,PASSWORD=<password>

AWS ECR is a service that allows us to create public/private repositories where we can store our docker containers online; otherwise known as container registries.

For our project, we will be using a private repos in AWS ECR which has a 500MB total storage limit on the free tier.

500MB is quite small, so in order to utilize this free tier benefit, we will only use these private repos as a means to securely store our deployment images online. We will not be using these repos to store various versions of our images. If we need to deploy updated images, we must overwrite the existing images.

The downside to this is that if need to downgrade to an older version, we cannot just deploy an older version of our image from the repo. We will have to manually recreate the older image, upload that to the repo, and redeploy. This is pretty tedious, but we do what we gotta do to save money 😭.

Currently available repos:

name: wordvision
type: private
uri: 739275474951.dkr.ecr.us-east-1.amazonaws.com/wordvision

In order to push to a private repo, you need to accomplish the following:

• AWS CLI installed and setup

  • Install AWS CLI by following this guide https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
  • Once AWS CLI is installed, run aws configure to configure the cli with our wordvision credentials found in our wordvision_credentials.txt

    $ aws configure
    AWS Access Key ID [None]: <refer to our credentials file>
    AWS Secret Access Key [None]: <refer to our credentials file>
    Default region name [None]: us-east-1
    Default output format [None]: json
    

  • AWS CLI is now setup

• Docker installed and setup

  • Ensure AWS CLI is setup
  • install docker from https://www.docker.com/
  • Login to ECR from docker by running the following command

    aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin 739275474951.dkr.ecr.us-east-1.amazonaws.com
    

  • Docker is now setup

You can now push to our private repo using docker. Follow the steps from this guide to do so: https://docs.aws.amazon.com/AmazonECR/latest/userguide/getting-started-cli.html#cli-push-image