Skip to content

Latest commit

 

History

History
241 lines (207 loc) · 9.5 KB

README.md

File metadata and controls

241 lines (207 loc) · 9.5 KB

🤖Your.ai🤖

Managing schedules and finding time for yourself can be difficult as a university student. Thankfully, Your.ai has got your back! Led by an LLM powered AI assistant, this web app will be able to connect to your calendar where all you need to do is speak or text the AI assistant how you want to tune your schedule, personal action items, and deadlines. Additionally, the web app can provide task management and organization in-house to make managing your schedule that much easier. Need to find time for the gym? Gotta do a grocery run this week? Finals to prep for? Your.ai can search your calendar and task list then reply to you with the best time management solutions just as if you were talking to your own personal assistant!

MVP ✅

  • User auth → account / profile
    • Google OAuth integration, set scopes to access/modify Google Calendar
  • Speak or text a natural language prompt regarding your calendar or task list (find the earliest time for x, how can I adjust for y, add z to my schedule)
    • Speech is processed into text and used as prompting for the LLM powered AI assistant, responds with atomic actions the server can take on the calendar using the Google Calendar API
    • AI assistant replies to the user with both voice and text
  • Push notifications that can be set by the AI assistant to remind the user of upcoming events or tasks due
    • Push notifications from the browser and/or email notifications
  • Create KanBan boards / to-do lists from given tasks, or prompt with some project description
  • Week-at-a-glance
    • Summary of weekly schedule and possible time management suggestions

Tech Stack & Resources 💻

MongoDB, Flask / Express.js, React

Comprehensive Full-Stack Tutorials

Front-end

Back-end

Third-party Integrations / APIs

Dev Tools/Software

Milestones 📅

Week Overall Frontend Tasks Backend Tasks
Week 1
  • Get to know everyone :)
  • Begin UI/UX design
  • Set up development environments for both front-end (React) and back-end (Express.js / Flask, MongoDB)
  • Set up development environments for front-end
  • Set up development environments for back-end
Week 2/3
  • 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)
  • Finalize UI/UX design concepts (Finish by end of Week 3)
  • Implement designs for Login/Register page and set-up homepage (will be finished in a later week)
  • Spin up MongoDB Atlas cluster, give everyone access and download Compass
  • Organize backend server and set up auth to authenticate through Google’s OAuth 2.0 (can import some package to handle working with OAuth or go full-send w/ Auth0)
  • Set up Google Calendar API
Week 4/5
  • Set up routing for pages and set up context components to handle the OAuth token
  • Implement speech-to-text audio processing for the React application
  • Create pages and components for KanBan board
  • Begin writing prompting for GPT (or other LLM) to understand user input as requests for specific Google Calendar API endpoints
  • Adjust prompting to allow GPT (or other LLM) to read and update user calendar data through requests to the Google Calendar API
Week 6/7
  • Continue the great work!
  • If there’s still time and space, choose a stretch goal to start developing
  • Begin brainstorming ideas for presentation night (be funny and have fun lol)
  • Finish pages and components for KanBan board
  • Implement notifications for the browser to read deadlines from the server and send notifications as needed
  • If needed, begin helping with back-end backlog
  • Finish up prompting for the LLM and the appropriate endpoints and API calls.
Week 8/9
  • Refine styling and other tweaks to pages/components, make sure everything is integrated well.
  • Test for bugs and any server side issues, make sure API endpoints are ready for use by the front-end for demo
Week 10 Test everything and fix any outstanding bugs. Have fun on presentation night!

Stretch Goals 💪

  • Integrate with other calendar services (Outlook, iPhone, etc) or a built in calendar.
  • Shared calendar(s) between users
  • Automatic event/task categorization and/or prioritization
  • Proactive time management recommendations (helpful tips based on user’s calendar activity)
  • Deployment + Real Users :0

GitHub Cheat Sheet 💬

Command Description
cd Change directories over to our repository
git branch Lists branches for you
git branch "branch name" Makes new branch
git checkout "branch name" Switch to branch
git checkout -b "branch name" Same as 2 previous commands together
git add . Finds all changed files
git commit -m "Testing123" Commit with message
git push origin "branch" Push to branch
git pull origin "branch" Pull updates from a specific branch
get commit hash (find on github or in terminal run git log --oneline ) then git revert 2f5451f --no-edit Undo a commit that has been pushed
git reset --soft HEAD~ Undo commit (not pushed) but keep the changes
get commit hash then git reset --hard 2f5451f Undo commit (not pushed) and remove changes

The Team 🎉

🎊Developers🎊

Suhani Rana


Krish Arora


Harsh Patel


Sreenidhi Palaniappan


🎊Project Manager🎊

Lerich Osay


🎊Industry Mentor🎊

Linh Ly