Homework Supply

This is a web application built with Next.js, Material UI, and AWS Amplify gen 1. The application allows users to create interactive assignments, track their progress, and has language learning features. This can process audio and images uploaded during the assignment and provide feedback based on the expected content. The application also allows users to upload images and generate content from text snippets.

Table of Contents

• Features
• Deploy AWS Amplify
• Installation
• Usage
• Requirements
  • OpenAI API Key
• License
• Contributing
• Code of Conduct

Features

1. Users can track their progress and performance over time.
2. Leverage LLMs to generate content from text snippets. Currently, this is limited to audio and image files.
3. LLM feedback allows users to dynamically compare their inputs with the expected content, real-time interactive assignments.
4. LLMs grade audio and drawings based on the expected content provided ahead of time by the instructor.
5. Allow users to upload their own audio and image files.
6. Allow users to create an account and login to the application.
7. Provide a dashboard that displays the user's progress and performance.
8. Allow users to browse and search for Japanese vocabulary words and phrases.
9. Provide flashcards and quizzes to help users learn and practice Japanese vocabulary.
10. Provide users with a simple text editor for generating new content.
11. Create learning groups and manage those learners' progress.
12. Assign content to groups.
13. Allow users to save their progress and resume learning at a later time.
14. Provide a mobile-responsive design that works well on both desktop and mobile devices.

Deploy AWS Amplify

This application uses AWS Amplify to manage the backend services. Button to deploy the application to your AWS account.

1. Add the Amplify cli npm install -g @aws-amplify/cli

2. Click the button above to deploy the application to your AWS account. Find the Amplify app id and environment name from the AWS console: https://us-east-1.console.aws.amazon.com/amplify/apps

3. Run the Pull command, but replace the amplify app by name and appid to match the current env: amplify pull --appId <AMPLIFY_APP_ID> --envName <AMPLIFY_ENV_NAME>.

4. HACK Manually add inline policy to the IAM role doing the deployment. This policy should allow amplify to list Cognito IDP resources. This is necessary for the application to assign groups with a custom resource. To do this:

   • Go to the IAM console: https://console.aws.amazon.com/iam/home#/roles
   • Find the role <AWS_REGION>_<ID>_Full-access
   • Click the "Add inline policy" button
   • Select the JSON tab and paste the following policy. This policy allows the role to list all groups in Cognito. This is necessary for the application to assign groups with a custom resource. The policy should look like this:

     {
         "Version": "2012-10-17",
         "Statement": [
             {
                 "Sid": "AllowIDP",
                 "Effect": "Allow",
                 "Action": [
                     "cognito-idp:GetGroup"
                 ],
                 "Resource": [
                     "*"
                 ]
             }
         ]
     }
     

5. amplify push -y to deploy the backend and frontend services to your AWS account. This will prompt you to add the openaiApiKey secret.

If something goes wrong with amplify push -y, Run amplify update function for both openai and editorChat functions, re upload the openai api key by updating the secret, and re-run amplify push -y.

Installation

1. Clone the repository: git clone https://github.com/ExcitingTheory/amplify-homework-supply.git
2. Install dependencies: npm install

Usage

1. Start the development server: npm run dev
2. Open your browser and navigate to http://localhost:3000
3. Open Test Runner npm run cypress:open

Requirements

1. Node.js
2. AWS Account
3. OpenAI API Key

OpenAI API Key

This application uses the OpenAI API to generate content from text snippets. You will need to sign up for an API key at OpenAI. Once you have your API key, you can add it to the

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contributing

Please read and follow our Contributing Guidelines to ensure a welcoming and inclusive environment.

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming and inclusive environment.