Skip to content

Latest commit

 

History

History
117 lines (85 loc) · 6.35 KB

README.md

File metadata and controls

117 lines (85 loc) · 6.35 KB

CulturePot

Stir up the melting pot of UTD's diversity with CulturePot! This app is designed to celebrate our diverse campus. Whether you're looking to practice a new language, share the richness of your cultural heritage, or connect with peers from different backgrounds, CulturePot is the app for you. Join your fellow students in swapping stories, languages, and traditions, and watch as your personal growth simmers to perfection. CulturePot: where every culture has a place in the pot, and different cultures season every conversation.

MVP 💰

  • User Account

    • User authentication with username and password.
    • Personalization - ex: profile photo, personal info, etc.
    • Add Friends
    • Allow users to include their native language, country of origin, cultural interests, traditional festivals, and favorite cultural practices to their profile
  • Cultural Showcase Feed

    • Users can post about their cultures, such as traditional recipes, music, stories, or holidays.
    • Acts as a mini-blog or social media timeline, allowing users to share and celebrate their unique cultural backgrounds.
    • Allow users to comment on posts on their feed
  • Language Phrasebook

    • Allow users to share common phrases or idioms in their native language
    • Complete with translations and usage examples
    • Help others learn key phrases and understand the nuances of different languages.
  • Basic Matchmaking System

    • A simple algorithm to match students for language exchange based on their profile information.

Stretch Goals 🙆

  • Gamification elements like Duolingo: Structured Language Lessons Interactive Quizzes and Exercises Daily Goals and Streaks

  • Video Call Integration: Incorporating secure video calling for more immersive language practice and cultural exchanges.

  • Resource Library: A comprehensive library with language learning resources, cultural articles, and recommended multimedia content.

  • Collaboration with Faculty and Organizations: Partnership features with campus organizations and faculty involvement for expert insights and language help.

Milestones 🏃‍♂️

Week Deliverables/Tasks
1 Meet team, set up development environment, explore ideas using similar apps
2 & 3 Front end: plan pages, create wireframes & code initial screens, get familiar with Flutter widgets, and start designing the UI for the user profile and cultural live feed. Back end: Firebase, create the Firebase project, and set up Firebase Authentication. Set up Firestore for user data. Implement user authentication and creation of user profiles in Firebase. Allow users to add friends. (Week 3)
4 Front end: 50% of app screens, Back-end: Implement backend for Cultural Showcase Feed and Language Phrasebook. Integrate with Front End
5 Front end: complete 75% of screens, Back end: Develop basic matchmaking algorithm and chat functionality. Continue to integrate with frontend as needed
6 & 7 Front end: 100% of app screens, enhancing features/animations, Back end: Sync Firestore data with language phrasebook depending on users preferences and who/what culture and language they are learning from
8 & 9 Setup Firebase Cloud Messaging, integrate with the frontend, finish integration of Front End and Back End
10 Practice presentation, final touches
11 Presentation Night!!

Tech Stack 💻

Wireframing: Figma
Front-end: Flutter
Back-end: Dart & Firebase

Helpful Resources/Tutorials 📚

Installation & Set Up:
Flutter Installation for Mac OS
Installation guide pt 2 for Mac OS
Flutter Installation for Windows
Flutter Installation for Windows pt 2
Firebase w/ Flutter Set Up
Install Android Studios
VS Code
Git
Xcode (for Mac users and the ios emulator and packages

Tutorials:
Flutter Tutorial
Figma Tutorial
Dart Tutorial
Git Tutorial
Git Cheat Sheet

How to implement push notifications with Flutter and Firebase Cloud Messaging
Working with Firebase CRUD and REST API's

Quick Read :) How to be Successful in Projects

GitHub Cheat Sheet ᛘ

Command Description
cd "CulturePot" 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

Developers 👥

Kruthi Vancha \ Vidur Nangia
Jack Le
Leila Igwegbe

Ridwan Amin - Project Manager
Sean Hassan - Industry Mentor