Skip to content

acm-projects/CometClaim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 

Repository files navigation

CometClaim 💫

UTD's Lost and Found system needs a digital upgrade to improve convenience. Instead of relying on physical visits or phone calls, CometClaim is an online platform where students and staff can easily upload and browse a virtual inventory of lost items, retrieve misplaced belongings, and query a chatbot for any questions from the comfort of their home before making a trip to the Lost and Found office.


MVP 🛠️

  • User account with user authentication
    • Administrator and student login
    • Item recovery history
  • Register New Items (Found and Lost)
    • Add "Pending Verification," "Claimed," or "Available for Pickup" statuses for items.
  • Fuzzy search to look for items
    • Item Categories and Filters
  • Claim Process
    • Submit tickets to claim items
  • Chatbot for answering any questions
    • If a person has claimed an item that is mine, what should I do?
    • What is the process for claiming an item?
  • Alerts/Notification System
    • when new items matching their description are added to the inventory.

Tech Stack & Resources 💻

Comprehensive Full-Stack Tutorials

Front-end

Back-end

Third-party Integrations / APIs

Dev Tools/Software

Milestones 📅

Week Overall Frontend Tasks Backend Tasks
Week 1
  • Discuss who’s frontend/backend and the overall project/tech stack
  • Set up communication, environments, and WhenToMeet
  • Set up development environments for both front-end and back-end
  • Begin UI/UX design
  • Set up development environments for front-end
  • Look into React and Tailwind
  • Set up development environments for back-end
  • Start looking into AWS tech stack
Week 2
  • Get familiar with tech stack
  • Begin starting with basic deliverables
  • Brainstorm schemas for the database (Both front-end and back-end should be in agreement before creating states/models)
  • Go over some UI design basics
  • Flesh out the collective vision for the app
  • Figma Design due by the end of week 2
  • Plan out database design schema
  • Keep doing research with the tech stack and AWS
Week 3/4
  • Begin starting with basic deliverables
  • Finalize UI/UX design concepts (Finish by end of Week 3)
  • Implement designs for Login/SignUp Pages, Upload/Claim Item pages, Search Page
  • Implement user auth with AWS Cognito due by End of Week 3
  • Set up routing for pages and set up context components
  • Configure the AWS environment with Polly, Lex, Amplify, and S3/DynamoDB
  • Set up S3 buckets for storing uploaded item photos
  • Start developing AWS Lex and AWS Polly
Week 5/6
  • Implement designs for Claim page, Home Page, and chatbot page/modal
  • Integrate user and item database with the frontend
  • Chatbot should be functional and reply to queries
Week 7/8
  • Backend and Frontend communicate to finish integration to connect and test
  • Have the entire app working
  • If possible work on stretch goals
  • Begin working on the script
  • Polish up MVP features and help the backend if needed
  • Finish everything
Week 9
  • EVERYONE HANDS ON to DEPLOY our app with AWS Amplify
Week 10
  • NO MORE CODING unless for bug fixes
  • Prepare for Presentation Night!
  • Polish app and slides so they are ready to go

Stretch Goals 🚀

  • Real-time call support for answering questions?
    • Connect me to a real person
    • Any other questions that the chatbot can use
  • Anonymous Reporting
  • Crowdsourcing
    • Allow students and staff to upload photos of lost items ANYWHERE on campus
  • Map Integration
  • Social Media Integration

Roadblocks and Possible Solutions 🚧 💡

  • React Environment Setup
    • Pivot to other technologies such as Svelte or Nuxt
  • Running to AWS Tech Stack Issues
    • If we are in the early stages, we would pivot to PERN/MERN (PostgreSQL, Express, React, Node)
  • Issues with AWS Kendra and AWS Lex (or AWS Polly)
    • Pivot to different technologies offering voice generation and AI Chat such as LangChain
  • Either the Frontend or Backend team falling behind.
    • If this happens the best course would be to get some assistance from the other side until caught up

Competition 🥊

  • UTD PD Lost and Found Inquiry

  • UTD SU Lost and Found

  • Social Media apps like (Reddit, Instagram, X)


Git Cheatsheet 📓

Command What it does
git init Initalize a new Git repo
git clone "rep-url" Clone a repo from a URL
git status Show changes status
git add "file" Add changes to staging, use "." for all
git commit -m "Descriptive Message" Commit changes with a message
git push Upload local repo content to a remote repo
git log View commit history
git branch Lists all the branches
git branch "branch-name" Create a new branch
git checkout "branch-name" Switch to a branch
git checkout -b "branch-name" Combines the previous 2 commands
git merge "branch-name" Merge changes from a branch
git branch -d "branch-name" Delete a branch
git push origin "branch-name" Push to branch
git pull origin "branch-name" Pull updates from a specific branch
git pull Fetch and merge changes
git fetch Fetch changes without merging
git reset --hard HEAD Discard changes
git revert Revert changes in a commit

CometClaim TEAM!! 🎉

  • Jason Luu - Project Manager
  • Suraj Khosla - Industry Mentor

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published