Skip to content

Latest commit

 

History

History
114 lines (85 loc) · 7.31 KB

README.md

File metadata and controls

114 lines (85 loc) · 7.31 KB
Raw

animated

SpeakWise

Have you ever struggled with public speaking or been nervous about acing that upcoming interview? SpeakWise is your ultimate companion for mastering the art of speech and interview preparation! Record your speech effortlessly within the app and watch as SpeakWise analyzes your tone, pace, and counts your filler words. Additionally, experience mock interviews catered to your job description with personalized interview questions and response analysis. Join SpeakWise – where your speaking troubles end and communication begins!

MVP 🌟

  • User Account
  • Record speech
  • Analyze tone using sentiment analysis
  • Analyze pace using WPM algorithm
  • Count filler words
  • AI generated interview questions based on job description

Stretch Goals 🪐

  • Daily challenges to reinforce speaking skills
  • Social Aspect (sharing stats such as number of filler words)
  • Analyze additional aspects of speech or interview responses (clarity, emotion, etc.)
  • Display statistics related to speech improvement (how the amount of filler words changes, etc.)
  • Give tips on how to improve speech based on analysis

Milestones 💫

Week Deliverables/Tasks
1 Meet team, assign frontend/backend, setup development environment, decide on app design
2 Finalize vision for the app, learn basics of Flutter/Dart, Front end: plan pages and create wireframes & code initial screens, Back end: Set up Google Firebase, begin coding user auth
3 & 4 Front end: 50% of pages, Back end: finish user authentication, implement speech-to-text API, begin sentiment analysis feature
5 & 6 Front end: 75% of pages, Back-end: finish sentiment analysis, create algorithm to find WPM, feature to count filler words
7 & 8 Front end: finish all pages, Back end: finish speech analysis features, work on AI generated Interview questions
9 & 10 Finish integrating all features, prepare slides and presentation, get app presentation ready
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
Flutter Installation for Windows
Firebase w/ Flutter Set Up
Install VSCode

Tutorials:
Flutter/Dart Intro (helpful for frontend)
Flutter/Dart Intro (helpful for backend)

Flutter Documentation
Adding Firebase to Flutter App
Firebase Documentation
Figma Tutorial
Dart Tutorial
Git Tutorial

Git Cheat Sheets:
Git Cheat Sheet 1
Git Cheat Sheet 2

Resources for Design:
Best App Design - copy and paste link if it takes you to forbidden
Dribble - copy and paste link if it takes you to forbidden
Color Palettes
More Color Palettes
Do's and Don'ts of Mobile App Design

API's:
Google Cloud Speech-To-Text API
Google Cloud Natural Language API
GPT-3 API

Other Resources:
Figma
Helpful Vids Playlist

How to be Successful in Projects

GitHub Cheat Sheet ⚡️

General Use

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

Developers‼️‼️

Sai Peram
Soujanya Prakash Kamalapur
Swayam Arora
Charitha Sarraju
Maunika Achanta

Kanchan Javalkar - Project Manager
Erik Rodriguez - Industry Mentor