diff --git a/README.md b/README.md index 8e27fa3..be5c2dc 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,65 @@ -
- - [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FGDSC-DGU%2F2024-SolutionChallenge-earlips-frontend&count_bg=%238B8B8B&title_bg=%231FA9DC&icon=wechat.svg&icon_color=%23E7E7E7&title=Connecting+your+ears+to+your+lips%2C+Earlips&edge_flat=false)](https://hits.seeyoufarm.com) +
+ -# ๐Ÿ‘‹ introduce team member -## [Front-End](/frontend/naemansan/README.md) +### ๐Ÿ‘‹ Introduce team member | name |major |GDSC | Email | | -------------------------------------------- | -------------- | ------ | -------------------- | -| [์„œํฌ์ฐฌ](https://github.com/seochan99) | Computer Science | LEAD | gmlcks0513@dgu.ac.kr | -| [ํ™ฉํ˜„์ •](https://github.com/bunju20) | Computer Science | General | ghkd4009@gmail.com | - - ---- +| [HUICHAN SEO](https://github.com/seochan99) | Computer Science | LEAD | gmlcks0513@dgu.ac.kr | +| [HYEONJUNG HWANG](https://github.com/bunju20) | Computer Science | General | ghkd4009@gmail.com | +| [SEONHO LEE](https://github.com/capableofanything)| Multi Media Engineering| Core |retsgo01@gmail.com| +| [EUNSEO LIM](https://github.com/som0309) |Imformation Comunication Engineering| General |eunseolim1018@naver.com| -# ๐Ÿ› ๏ธ Tech -## Frameworks -![Flutter](https://img.shields.io/badge/Flutter-02569B?style=for-the-badge&logo=flutter&logoColor=white) -![Dart](https://img.shields.io/badge/Dart-0175C2?style=for-the-badge&logo=dart&logoColor=white) -![FastAPI](https://img.shields.io/badge/FastAPI-009688?style=for-the-badge&logo=fastapi&logoColor=white) +
+
-## Server -![Google Cloud](https://img.shields.io/badge/Google%20Cloud-4285F4?style=for-the-badge&logo=google-cloud&logoColor=white) -![Firebase](https://img.shields.io/badge/Firebase-FFCA28?style=for-the-badge&logo=firebase&logoColor=black) +# UN-SDGs that our solution is solving for +

+ + +

-## Stack +Our solution aims to provide hearing-impaired individuals with equal opportunities to express their thoughts freely through a pronunciation correction process. This process converts pronunciation into text for visual feedback, uses AI to detail areas needing improvement, and transforms the user's pronunciation into vibrations to provide tactile feedback. With our pronunciation correction process, we strive to eliminate the fear of speaking among the hearing-impaired and create a world where they can express their thoughts freely. -![http](https://img.shields.io/badge/http-0.13.6-red?style=for-the-badge) -![uuid](https://img.shields.io/badge/uuid-3.0.7-blue?style=for-the-badge) +Our approach aligns with promoting inclusive education (SDG 4) and reducing inequalities (SDG 10). We aim to contribute to a more inclusive and equitable world where everyone can freely express their thoughts, enjoy quality education, and experience reduced inequalities. -![PyMySQL](https://img.shields.io/badge/PyMySQL-1.0.3-374da9?style=for-the-badge) -![Scikit-learn](https://img.shields.io/badge/Scikit--learn-1.2.1-orange?style=for-the-badge) ---- -## Flutter Project Build Instructions -``` -flutter pub get -flutter run - -## If you encounter any issues in iOS build, follow these steps to clean your build cache for iOS -cd ios -rm Podfile.lock -rm Podfile -rm -rf Pods -pod cache clean --all -cd .. -flutter clean -flutter pub get -cd ios -pod install -flutter pub get -flutter run - -## If you encounter any issues in Android build, follow these steps to clean your build cache for Android -cd android -./gradlew clean -cd .. -flutter clean -flutter pub get -flutter run -``` ## Project Introduction image ## Architecture image -### ๐Ÿ’ป demonstration video -[![์˜ˆ์ œ](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/85238126/1db0ed9d-2afc-4f17-aa1e-51e0b03f278a)](https://youtu.be/DLwqB820kL8) -https://youtu.be/DLwqB820kL8 +# โœจ Demo + +video : ๋งํฌ์ƒ๊ธฐ๋ฉด ์—ฌ๊ธฐ์— ์ถ”๊ฐ€! -### โœจ Screen -| Title | Img | Title | Img | -| ------------ | ---------------------------------------- | ------------ | ---------------------------------------- | -| Study Screen | ![Screenshot_20240222_062040](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/78739194/1b55af36-eb6a-43ab-befb-f70625d52dae) | Home Screen | ![Screenshot_20240222_062034](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/78739194/e9665bab-7466-468d-a3a3-4d87e7b39166) | -| Script Study | ![Screenshot_20240222_062105](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/78739194/8f6f42e0-1425-48fa-b6f4-a2288c64e0ce) | Study-word | ![Screenshot_20240222_062221](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/78739194/14058380-1516-4a36-b24e-0df5ee81fad7) | -| word study result | ![Screenshot_20240222_062230](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/78739194/e7cab7e7-06ac-4b6e-b1a0-15413966fcd8) | Sentence Study | ![Screenshot_20240222_062239](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/78739194/b3bcc778-bbc6-4b40-b5f8-c2ea6fe2c63e) | +| Home Screen | Learning Screen | Phoneme Screen | Word Screen | +|-------------|-----------------|----------------|-------------| +| ![Home Screen](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/85238126/2cd6880c-c41e-40cf-9083-3123bbe650e6) | ![ํ•™์ŠตํŽ˜์ด์ง€](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/85238126/751e16d6-2652-4fad-94d7-96b732635370) | ![๋ฐœ์Œ๊ธฐํ˜ธ](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/85238126/bbd023dc-556c-4a8d-b965-ac1ce5c6e174) | ![๋‹จ์–ดํ•™์Šตํ•˜๊ธฐ](https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/85238126/a3c3a348-2b66-4927-abb0-06132f2a4015) | + +**Home Screen** : Pronunciation score and daily learning graphs +**Learning Screen**: Learning logs by date +**Phoneme Screen** : Visuals and guides for phoneme articulation +**Word Screen** : Features *sound-to-vibration buttons* , GIFs for pronunciation practice, interactive phoneme guides with Google's Gemini, detailed phoneme explanations, and *voice recording with result review* + +| Sentance Screen(fix) | Paragraph Screen | Script Screen | live Screen(fix) | +|-------------|-----------------|----------------|-------------| +| ![แ„†แ…ฎแ†ซแ„Œแ…กแ†ผแ„’แ…กแ†จแ„‰แ…ณแ†ธ](https://github.com/bunju20/2024-SolutionChallenge-earlips-frontend/assets/85238126/2c4b86d8-7e27-48d9-9f56-86e5c3e1ea51) |![แ„†แ…ฎแ†ซแ„ƒแ…กแ†ซแ„’แ…กแ†จแ„‰แ…ณแ†ธแ„’แ…กแ„€แ…ต](https://github.com/bunju20/2024-SolutionChallenge-earlips-frontend/assets/85238126/9ddaf06b-a493-45d5-83f7-655770ab6db4) | ![แ„ƒแ…ขแ„‡แ…ฉแ†ซแ„†แ…กแ†ซแ„ƒแ…ณแ†ฏแ„€แ…ฉแ„€แ…งแ†ฏแ„€แ…ชแ„€แ…กแ†น](https://github.com/bunju20/2024-SolutionChallenge-earlips-frontend/assets/85238126/1b1d506e-4b53-4c53-bce9-1eaab7a5dc10) | ![แ„…แ…กแ„‹แ…ตแ„‡แ…ณ](https://github.com/bunju20/2024-SolutionChallenge-earlips-frontend/assets/85238126/d8b06861-7395-4c2d-8f7d-58fe6ccd8847) | + +**Sentence Screen**: Same layout as the Word Screen. +**Paragraph Screen**: Allows users to record their voice for a given script and receive feedback. +**Script Screen**: Users can write their own scripts and record their voice for feedback. +**Live Screen**: Displays the user's pronunciation in real time. ---- ## ๐ŸŽฏ Commit Convention @@ -112,4 +87,35 @@ https://youtu.be/DLwqB820kL8 | ๐Ÿ’ก | :bulb | Adding/updating comments | | ๐Ÿ—ƒ | :card_file_box | Database-related modifications | -## Lisence + + +## Flutter Project Build Instructions +``` +flutter pub get +flutter run + +## If you encounter any issues in iOS build, follow these steps to clean your build cache for iOS +cd ios +rm Podfile.lock +rm Podfile +rm -rf Pods +pod cache clean --all +cd .. +flutter clean +flutter pub get +cd ios +pod install +flutter pub get +flutter run + +## If you encounter any issues in Android build, follow these steps to clean your build cache for Android +cd android +./gradlew clean +cd .. +flutter clean +flutter pub get +flutter run +``` + +### ๐Ÿ› ๏ธ Tech +![Flutter](https://img.shields.io/badge/Flutter-02569B?style=for-the-badge&logo=flutter&logoColor=white) ![Dart](https://img.shields.io/badge/Dart-0175C2?style=for-the-badge&logo=dart&logoColor=white) ![FastAPI](https://img.shields.io/badge/FastAPI-009688?style=for-the-badge&logo=fastapi&logoColor=white) ![Google Cloud](https://img.shields.io/badge/Google%20Cloud-4285F4?style=for-the-badge&logo=google-cloud&logoColor=white) ![Firebase](https://img.shields.io/badge/Firebase-FFCA28?style=for-the-badge&logo=firebase&logoColor=black) ![http](https://img.shields.io/badge/http-0.13.6-red?style=for-the-badge) ![uuid](https://img.shields.io/badge/uuid-3.0.7-blue?style=for-the-badge) ![PyMySQL](https://img.shields.io/badge/PyMySQL-1.0.3-374da9?style=for-the-badge) ![Scikit-learn](https://img.shields.io/badge/Scikit--learn-1.2.1-orange?style=for-the-badge)