Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jwson-automation committed Aug 12, 2024
1 parent 607abf1 commit 45fe54d
Showing 1 changed file with 25 additions and 64 deletions.
89 changes: 25 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,40 @@
## 블루베리 템플릿이 뭔가요?
# 세이프 보이스: 집에서 남자 목소리를 출력해 안전을 지켜주는 든든한 앱

- 쇼핑몰, 커뮤니티, 소개팅, 등의 자주 사용되는 서비스에 필요한 코드를 모두 넣어둔 템플릿입니다.
## 소개

## 코드를 어떻게 확인하면 되나요?
**세이프 보이스**는 자취방에서 혼자 사는 사람을 위한 안전 애플리케이션입니다.
이 앱은 자취하는 집에서 기기를 통해 남자 목소리를 출력, 수상한 인물의 접근을 경고하고, 사용자의 안전을 지켜주는 든든한 동반자가 되어줍니다.
문 앞에 아빠의 구두를 두는 것처럼, 앱이 남자 목소리로 혼자 사는 집에서의 더 편안한 휴식을 제공합니다.

<img alt="a1" width="500" src="https://github.com/jwson-automation/blueberry_template/assets/108061510/fcb2e019-5cbc-4d5f-b47e-a0b6755858ac">
## 주요 기능

- 블루베리 템플릿의 모든 코드는 `위젯 - 프로바이더`의 아주 단순한 구조로 이루어져 있습니다.
- 빌드 후 필요한 화면을 찾으셨다면 해당 화면에 필요한 버튼(위젯)을 찾으시고 그 위젯과 연결된 프로바이더를 확인해주세요.
- **귀가 시간 알람**: 사용자가 설정한 시간에 맞춰서 남자 목소리로 음성을 출력합니다. ( " 오늘도 수고했어. 잘 다녀왔어? ")
- **남자 목소리 출력**: 여러가지 선택지를 제공해, 상황에 맞게 남자 목소리를 출력, 수상한 사람의 접근을 경고하고, 사용자의 안전을 강화합니다. ( " 누구세요? ", " 너 누구야! ")
- **경찰 신고 기능**: 주변의 경찰서 번호를 제공하고, 긴급 상황에서 즉각적인 신고를 도와줍니다.
- **사용자 설정**: 출력하는 음성을 자유롭게 생성, 준비할 수 있습니다.

## 이 레포지토리에 기여하려면 어떻게 하면 되나요?
- 오픈소스인 블루베리 템플릿을 함께 만들어가실 개발자, 디자이너 모집중입니다 :)
- 카카오톡 링크 : https://open.kakao.com/o/savka5yg
( 플러터 초심자 분들의 협업 학습을 위한 2주간의 인턴 체험도 진행중이니 신청해주세요! )

## 어떻게 빌드하나요?
## 설치 방법

0. Android Studio, Xcode의 최신화를 해 주세요.
1. **앱 다운로드**: [앱 다운로드 링크]를 클릭하여 앱을 다운로드합니다.
2. **앱 설치**: 다운로드한 파일을 열어 설치를 진행합니다.
3. **앱 설정**: 앱을 실행한 후, 경고 음성과 감지 기준을 설정합니다.

1. 플러터 버전을 최신으로 업데이트 해 주세요. `FVM 설정 예정`
- Flutter Version Upgrade
## 사용 방법

2. 앱 빌드를 위한 폴더들을 생성해주세요.
- 터미널에 `flutter create .` 입력
1. **앱 실행**: 앱을 실행하여 메인 화면을 확인합니다.
2. **설정**: 위치 설정과 경고 음성을 사용자 맞춤으로 설정합니다.
3. **안전 모드 활성화**: 앱이 활성화되면, 집 주변에서 수상한 인물이 감지되었을 때 남자 목소리로 자동 경고를 출력합니다.

3. 파이어베이스 설정을 해주세요.
- 파이어베이스 프로젝트 생성
- 'curl -sL https://firebase.tools | bash'
- 'dart pub global activate flutterfire_cli'
- `flutterfire configure --project={본인의 파이어베이스 프로젝트 명}'
```
Which platforms should your configuration support (use arrow keys & space to select)?
[v] Android
[v] iOS
[v] Web
Which Android application id (or package name) do you want to use for this configuration, e.g. 'com.example.app'
package name : com.blueberry.template
```
4. google-services.json, GoogleService-Info.plist 파일을 프로젝트에 추가해주세요.
- `파이어베이스 콘솔 접속 > 프로젝트 설정 > 프로젝트 설정 > 아래로 스크롤 > 내 앱` 에서 다운로드 가능합니다.
## 지원

!!주의!!
- **문의**: 문제가 발생하거나 지원이 필요하신 경우, [지원 이메일]로 연락주시기 바랍니다.
- **FAQ**: 자주 묻는 질문은 [FAQ 링크]에서 확인하실 수 있습니다.

3번 항목은 하지말아주세요! `빌드가 불안정하게 변합니다.`
## 라이센스

<img width="500" alt="caution!" src ="https://github.com/user-attachments/assets/911a03ec-a1ca-4054-a36e-b6e4e67f0c7e">
이 프로젝트는 [MIT 라이센스](LICENSE) 하에 라이센스가 부여됩니다.

만약 이미 해버리셨다면 iOS 폴더를 삭제 후 다시 `flutter create .` 해주세요.
5. Firebase 기능을 활성화 해주세요.
```
Authentication > 시작하기 > 로그인 방법 > 이메일/비밀번호 활성화
Firestore Database > 데이터베이스 만들기 > 테스트 모드에서 시작
Storage > 시작하기 > 테스트 모드에서 시작
```
6. Freezed 파일과 Gen 파일을 생성해주세요.
- `flutter pub run build_runner build --delete-conflicting-outputs` 커맨드를 터미널에 입력합니다.
- `fluttergen` 커맨드를 터미널에 입력합니다.
## 참고
웹 빌드시에는 렌더러를 사용해야 합니다.
WEB IMAGE RENDERING (https://docs.flutter.dev/development/platform-integration/web/renderers)
- `flutter run -d chrome --web-renderer html`
로그인 기능(구글,애플,깃허브)를 이용하기 위해서 각 서비스의 키 설정이 필요합니다.
- 자세한 설명은 깃허브 위키를 참고해주세요.
- ![깃허브 위키](https://github.com/blueberry-team/blueberry_template/wiki/%EC%86%8C%EC%85%9C-%EB%A1%9C%EA%B7%B8%EC%9D%B8-Native,-Console-%EC%84%A4%EC%A0%95-%EB%B0%A9%EB%B2%95)
## 템플릿 기반 서비스 오픈 계획
![image](https://github.com/jwson-automation/blueberry_template/assets/108061510/e451dfde-9141-42a5-805c-a0062a9c11e2)
## 저작권

© 2024 세이프 보이스 팀

0 comments on commit 45fe54d

Please sign in to comment.