-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #64 from bunju20/develop
✨doc: readme 수정
- Loading branch information
Showing
1 changed file
with
68 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,90 +1,65 @@ | ||
| <div><img src="https://capsule-render.vercel.app/api?type=waving&color=0:1FA9DC,100:D5E9AA&text=Earlips" /></div> | ||
|
|
||
|
|
||
| [](https://hits.seeyoufarm.com) | ||
|
|
||
| <div><img src="https://capsule-render.vercel.app/api?type=waving&height=200&color=0:1FA9DC,100:D5E9AA&text=Earlips&descAlignY=100&descAlign=62&textBg=false&fontColor=FFFFFF&fontSize=70&animation=fadeIn&rotate=0&strokeWidth=0&descSize=20" /></div> | ||
|
|
||
|
|
||
| # 👋 introduce team member | ||
|
|
||
| ## [Front-End](/frontend/naemansan/README.md) | ||
| ### 👋 Introduce team member | ||
|
|
||
| | name |major |GDSC | Email | | ||
| | -------------------------------------------- | -------------- | ------ | -------------------- | | ||
| | [서희찬](https://github.com/seochan99) | Computer Science | LEAD | [email protected] | | ||
| | [황현정](https://github.com/bunju20) | Computer Science | General | [email protected] | | ||
|
|
||
|
|
||
| --- | ||
| | [HUICHAN SEO](https://github.com/seochan99) | Computer Science | LEAD | [email protected] | | ||
| | [HYEONJUNG HWANG](https://github.com/bunju20) | Computer Science | General | [email protected] | | ||
| | [SEONHO LEE](https://github.com/capableofanything)| Multi Media Engineering| Core |[email protected]| | ||
| | [EUNSEO LIM](https://github.com/som0309) |Imformation Comunication Engineering| General |[email protected]| | ||
|
|
||
| # 🛠️ Tech | ||
|
|
||
| ## Frameworks | ||
|  | ||
|  | ||
|  | ||
| </br> | ||
| </br> | ||
|
|
||
| ## Server | ||
|  | ||
|  | ||
| # UN-SDGs that our solution is solving for | ||
| <p align="left"> | ||
| <img src="https://github.com/bunju20/2024-SolutionChallenge-earlips-frontend/assets/85238126/b2dff9f2-a73a-4757-820d-6db9eeb9d140" width="200" height="200"/> | ||
| <img src="https://github.com/bunju20/2024-SolutionChallenge-earlips-frontend/assets/85238126/f8055493-2f91-407f-b3cd-dee878dd0d8f" width="200" height="200"/> | ||
| </p> | ||
|
|
||
| ## 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. | ||
|
|
||
|  | ||
|  | ||
| 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. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## 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 | ||
| <img width="100%" alt="image" src="https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/85238126/1db0ed9d-2afc-4f17-aa1e-51e0b03f278a"> | ||
|
|
||
| ## Architecture | ||
| <img width="100%" alt="image" src="https://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/85238126/20616201-352f-4983-8266-4f2298200275"> | ||
|
|
||
| ### 💻 demonstration video | ||
| [](https://youtu.be/DLwqB820kL8) | ||
| https://youtu.be/DLwqB820kL8 | ||
|
|
||
|
|
||
| # ✨ Demo | ||
|
|
||
| video : 링크생기면 여기에 추가! | ||
|
|
||
| ### ✨ Screen | ||
| | Title | Img | Title | Img | | ||
| | ------------ | ---------------------------------------- | ------------ | ---------------------------------------- | | ||
| | Study Screen |  | Home Screen |  | | ||
| | Script Study |  | Study-word |  | | ||
| | word study result |  | Sentence Study |  | | ||
| | Home Screen | Learning Screen | Phoneme Screen | Word Screen | | ||
| |-------------|-----------------|----------------|-------------| | ||
| |  |  |  |  | | ||
|
|
||
| **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) | | ||
| |-------------|-----------------|----------------|-------------| | ||
| |  | |  |  | | ||
|
|
||
| **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 | ||
|          | ||