Lotion Plus

Netflify Link: https://650359b75923cf193b85ac19--preeminent-pony-526e04.netlify.app/

In this assignment, you will create a backend on AWS for the Lotion app you created in a previous assignment. You will use Terraform for creating resources on AWS.

You may use the front-end you built in the previous assignment here if it works properly. If not, you need to make sure it does by the time you demo your work. This could be a group assignment (groups of maximum 2 students). Please read the Group Assignment part carefully so you won't lose any points.

Architecture Overview

🦶 Steps

• Make sure to see the demo video on D2L
• Clone the repo
• Make sure you're inside the root directory of the repo and then run npm install to install all the necessary packages
• Run npm start and you should be able to see the page open up on your default browser
• Add your infrastructure code in the main.tf file
• Add your function code for the get-notes-<your-ucid> function in the functions/get-notes/main.py file
• Add your function code for the save-note-<your-ucid> function in the functions/save-note/main.py file
• Add your function code for the delete-note-<your-ucid> function in the functions/delete-note/main.py file
• Push your changes to the main branch before the deadline to be graded
• Create a new PRIVATE repo under your username and add it as a new remote to the project: git remote add personal <github-address>. This could be the same repo you used for the previous assignment. You don't have to create a new one. I say PRIVATE in case you accidentally put some sensitive information in your repo (e.g. AWS Credentials. DON'T DO THAT!!)
• Push your changes to your personal repo as well: git push personal main
• Use Netlify to deploy your application and drop the link to your website in the NETLIFY-ADDRESS file

📃 Notes

• You must use Google as the login method for the app. The demo uses the @react-oauth/google library. To use Google as a login method, you need to create a project on Google Cloud Platform first and use the client_id you generate in your app. See this tutorial on how to create such a project and connect it to your React app. It's Free, but you need to put in credit card info to create a Google Cloud account

• You must create all your resources on AWS with Terraform. Put all your configuration in the main.tf file

• You must use AWS DynamoDB for the database. Feel free to use the same setup (Partition and Sort Key) shown in the Demo. The demo uses a table named lotion (you must name your table lotion-<your-ucid>) with email as Partition Key and note id as Sort Key. This is an easy setup which will let you store everybody's notes in one table and retrieve/update/delete them easily. Note that if you use this method, you need to use the DynamoDB Query operation to retrieve all the notes for a user

• You must use Lambda Function URLs for this assignment to connect your backend to the frontend

• You must create 3 Lambda functions for this assignment:

  • get-notes-<your-ucid>: to retrieve all the notes for a user. The function reads the user email from the query parameter email, and receives email and access_token (this is the token you get from the Google login library) in the headers. Function URL only allows GET requests
  • save-note-<your-ucid>: to save/create/update a note for a user. The function reads the note to be saved/created/updated from the body of the request, and receives email and access_token in the headers. Function URL only allows POST requests
  • delete-note-<your-ucid>: to delete an existing note for a user. The function reads the user email from the query parameter email, and receives email and access_token in the headers. Function URL only allows DELETE requests

• You need to use the email and access_token you get in the headers of the requests to make sure the user is authenticated properly. If not, the functions should return the HTTP status code 401 for unauthenticated requests

• In order to get the full mark, you need to DEMO your work in PERSON. You could either demo it to a TA or the instructor. Demo is 50% of the assignment

👫 Group Assignment

In case you're doing the assignment as part of a group, pay attention to the following so you won't lose any points:

• Use the UCID of one team member to name the Lambdas, and the other one to name the DynamoDB table
• Put the names and UCIDs of the team members in the Team-Members file
• Both members must commit to the group repo. If a student has no commit after the deadline, their grade will be Zero. Things like "I sent the code over TikTok or Discord" are not acceptable. No commmit = No grade
• Try to split the work as evenly as possible between team members
• Both members must be present for the Demo. If you're not present, your grade will be Zero for the Demo

✔️ Things you may change

• You may use a different library for Google authentication
• You may use a CSS framework to build the UI
• You may choose either Python or Golang to write your Lambda functions

📛 Things you may not change (points will be deducted if you do)

• Use of a DynamoDB table
• Use of 3 Lambda functions to build the backend
• Use of Terraform to build the resources on AWS
• Naming patterns discussed above: your resources must have your UCID(s) in their name

💰 AWS Cost

• This assignment won't cost you anything if you follow the best practices discussed in the class
• Use the PROVISIONED billing mode, and only 1 RCU and WCU for your DynamoDB table as shown in the lecture notes
• Don't use a memory configuration bigger than 128MB for your Lambdas. Use the lecture notes to create Lambda functions. When you don't specify the memory_size field, it will default to 128MB which is the minimum amount
• Don't send a huge number of requests to your Lambdas using automated scripts. You have 1 Million free requests, and up to 3.2 million seconds of free compute time under the Free Tier
• Remember to enable Free Tier notifications on your account before building anything as shown in the videos on D2L
• If you go over the Free Tier (you would have to screw it up really bad, honestly), you can create a new Free AWS account and build your infrastructure there instead. Thankfully, Terraform makes that process super easy for you