Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bunju20 authored May 5, 2024
1 parent 3d197d4 commit 3ddce72
Showing 1 changed file with 49 additions and 55 deletions.
104 changes: 49 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,79 +4,46 @@



# 👋 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] |


---

# 🛠️ Tech
| [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]|

## 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)
</br>
</br>

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

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

![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)
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://github.com/GDSC-DGU/2024-SolutionChallenge-earlips-frontend/assets/85238126/1db0ed9d-2afc-4f17-aa1e-51e0b03f278a)](https://youtu.be/DLwqB820kL8)
https://youtu.be/DLwqB820kL8

### 🛠️ Tech
| Frameworks |Server |Stack |
| -------------------------------------------- | -------------- | ------ |
| ![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) |

# ✨ Demo

### ✨ Screen
video : 링크생기면 여기에 추가!

| Home Screen | Learning Screen | Phoneme Screen | Word Screen |
|-------------|-----------------|----------------|-------------|
Expand All @@ -96,7 +63,7 @@ https://youtu.be/DLwqB820kL8
**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 @@ -124,4 +91,31 @@ 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
```

0 comments on commit 3ddce72

Please sign in to comment.