Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨doc: readme 수정 #64

Merged
merged 5 commits into from
May 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 68 additions & 62 deletions README.md
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>


[![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)

<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
![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)
</br>
</br>

## 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
<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.

![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
<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://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

Expand Down Expand Up @@ -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)
Loading