-
Notifications
You must be signed in to change notification settings - Fork 0
[add/#5] 아이콘 추가 및 README 작성 #7
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
Merged
Merged
Changes from 3 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or 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,2 +1,239 @@ | ||
| # Kiero-Android | ||
| Kiero 안드로이드 레포잉 👶 | ||
| Kiero 안드로이드 레포지토리 👶 | ||
|
|
||
|
|
||
|
|
||
| <div align="center"> | ||
|
|
||
|  | ||
|  | ||
|  | ||
|
|
||
| ### 아이의 하루가 모험이 되는 곳 | ||
|
|
||
| <img width="1024" height="500" alt="image" src="" /> | ||
|
|
||
| **초등학생 자녀의 일정 관리와 자기주도적 습관 형성을 돕는** | ||
| **게이미피케이션 기반 성장 플랫폼** | ||
|
|
||
| [Download](#download) • [Features](#features) • [Architecture](#architecture) | ||
|
|
||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| ## 💡 About Kiero | ||
|
|
||
| > "세상의 모든 아이는 '히어로'다" | ||
|
|
||
| **Kiero**는 'Kid(아이)'와 'Hero(히어로)'의 합성어입니다. | ||
|
|
||
| 잔소리가 응원이 되고, 의무가 모험이 되는 곳. | ||
| 부모와 아이가 함께 성장하는 가족 운영 플랫폼을 만듭니다. | ||
|
|
||
| ### For Parents 👑 | ||
| 잔소리 → 응원 | 불안 → 안심 | ||
| 아이의 성취를 확인하고 칭찬하며, 흩어진 스케줄을 한곳에서 관리합니다. | ||
|
|
||
| ### For Kids 🦸 | ||
| 의무 → 모험 | 통제 → 도전 | ||
| 시간표가 모험 지도로 변하고, 스스로 퀘스트를 시작하며 보상을 획득합니다. | ||
|
|
||
| ### For Family 👨👩👧👦 | ||
| 통제 → 협력 | ||
| 함께 약속을 정하고 지켜나가며, 서로를 든든한 팀원으로 느낍니다. | ||
|
|
||
| --- | ||
|
|
||
| ## ✨ Features | ||
|
|
||
| ### 🎯 서비스 플로우 | ||
|
|
||
| ``` | ||
| 부모의 설계 → 아이의 도전 → 가족의 보상 → 신뢰의 형성 | ||
| ``` | ||
|
|
||
| **STEP 1. 부모의 설계** | ||
| - 일정 등록 → 아이 화면의 `오늘의 레시피`로 변환 | ||
| - 미션 등록 → 아이 화면의 `마을 의뢰서`로 변환 | ||
| - AI 알림장 입력기로 자동 미션 생성 | ||
|
|
||
| **STEP 2. 아이의 도전** | ||
| - 퀘스트 수행 후 인증샷 제출 | ||
| - 보석(포인트) 즉시 획득 | ||
| - 현실의 성취가 게임 배경으로 반영 | ||
|
|
||
| **STEP 3. 가족의 보상** | ||
| - 소원 상점에서 보석으로 쿠폰 교환 | ||
| - 게임 30분 연장, 치킨 먹기 등 실질적 보상 | ||
| - 노력의 가시화 | ||
|
|
||
| **STEP 4. 신뢰의 형성** | ||
| - 부모는 피드로 아이의 성취 확인 | ||
| - 승인과 칭찬 메시지 전송 | ||
| - 선순환 구조 완성 | ||
|
|
||
| --- | ||
|
|
||
| ## 📥 Download | ||
|
|
||
| <a href="https://play.google.com/store/apps/details?id=com.kiero"> | ||
| <img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" height="80"/> | ||
| </a> | ||
|
|
||
| --- | ||
|
|
||
| ## 🏗 Architecture | ||
|
|
||
| ### Layer Structure | ||
|
|
||
| Google Recommended App Architecture를 기반으로 설계되었습니다. | ||
|
|
||
| ```mermaid | ||
| graph TB | ||
| subgraph UI["UI Layer (Presentation)"] | ||
| P1[auth / kid / parent / main<br/>Compose UI + ViewModel + UiState] | ||
| end | ||
|
|
||
| subgraph Domain["Domain Layer"] | ||
| D1[auth / kid / parent<br/>Repository Interface + Entity + UseCase] | ||
| end | ||
|
|
||
| subgraph Data["Data Layer"] | ||
| DA1[auth / kid / parent<br/>Repository Impl + DataSource + DTO] | ||
| end | ||
|
|
||
| subgraph Core["Core Modules"] | ||
| direction LR | ||
| CN[Network] | ||
| CD[DesignSystem] | ||
| CNV[Navigation] | ||
| CC[Common] | ||
| CM[Model] | ||
| end | ||
|
|
||
| UI --> Domain | ||
| Domain --> Data | ||
|
|
||
| UI -.-> Core | ||
| Domain -.-> Core | ||
| Data -.-> Core | ||
|
|
||
| style UI fill:#81C784 | ||
| style Domain fill:#64B5F6 | ||
| style Data fill:#455A64 | ||
| style Core fill:#FFE082 | ||
| ``` | ||
|
|
||
|
|
||
| ### Package Structure | ||
|
|
||
| ``` | ||
| com.kiero | ||
| ├── core/ | ||
| │ ├── common | ||
| │ │ ├── extension/ Kotlin 확장 함수 | ||
| │ │ └── util/ 공통 유틸 함수 | ||
| │ ├── designsystem | ||
| │ │ ├── component/ 공통 UI 컴포넌트 | ||
| │ │ └── theme/ 디자인 시스템 (Color, Typography 등) | ||
| │ ├── model/ 공통으로 사용하는 모델 | ||
| │ ├── navigation/ 앱 전역 Navigation 정의 | ||
| │ └── network | ||
| │ ├── di/ 네트워크 관련 DI 모듈 | ||
| │ └── model/ 공통 네트워크 모델 | ||
| │ | ||
| ├── data | ||
| │ ├── auth | ||
| │ │ ├── local | ||
| │ │ │ ├── datasource | ||
| │ │ │ └── datasourceimpl/ Local DataSource 구현체 | ||
| │ │ ├── mapper/ DTO ↔ Domain Entity 매핑 | ||
| │ │ ├── remote | ||
| │ │ │ ├── api/ Retrofit Service | ||
| │ │ │ ├── datasource | ||
| │ │ │ ├── datasourceimpl/ Remote DataSource 구현체 | ||
| │ │ │ └── dto | ||
| │ │ └── repositoryimpl/ Domain Repository 구현체 | ||
| │ │ | ||
| │ ├── kid/ auth와 동일한 구조 | ||
| │ ├── parent/ auth와 동일한 구조 | ||
| │ └── di/ Data Layer DI 모듈 | ||
| │ | ||
| ├── domain | ||
| │ ├── auth | ||
| │ │ ├── model/ Domain Entity | ||
| │ │ │ └── DummyEntity | ||
| │ │ └── repository/ Repository Interface | ||
| │ │ └── DummyRepository | ||
| │ │ | ||
| │ ├── kid/ auth와 동일한 구조 | ||
| │ └── parent/ auth와 동일한 구조 | ||
| │ | ||
| └── presentation | ||
| ├── auth | ||
| │ ├── component/ Auth 전용 UI 컴포넌트 | ||
| │ ├── model/ UiState, UiEvent, SideEffect | ||
| │ ├── navigation/ Auth 관련 Navigation | ||
| │ ├── viewmodel/ 상태 관리 (ViewModel) | ||
| │ └── AuthScreen.kt | ||
| │ | ||
| ├── kid | ||
| ├── main | ||
| ├── parent | ||
| └── KieroApplication | ||
|
|
||
| ``` | ||
|
|
||
| ------ | ||
| ## 👥 Contributors | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/vvan2"> | ||
| <br /> | ||
| <sub><b>손주완 (Lead)</b></sub> | ||
| </a> | ||
| <br /> | ||
| <sub></sub> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/sonms"> | ||
| <br /> | ||
| <sub><b>손민성</b></sub> | ||
| </a> | ||
| <br /> | ||
| <sub></sub> | ||
| </td> | ||
| <td align="center"> | ||
| <a href="https://github.com/seungjae708"> | ||
| <br /> | ||
| <sub><b>최승재</b></sub> | ||
| </a> | ||
| <br /> | ||
| <sub></sub> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"> | ||
| <a href="https://github.com/dmp100"> | ||
| <br /> | ||
| <sub><b>성규현</b></sub> | ||
| </a> | ||
| <br /> | ||
| <sub></sub> | ||
| </td> | ||
| <td></td> | ||
| <td></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| --- | ||
|
|
||
| <div align="center"> | ||
|
|
||
| **Made with ❤️ by Kiero Team** | ||
|
|
||
| </div> | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <vector xmlns:android="http://schemas.android.com/apk/res/android" | ||
| android:width="24dp" | ||
| android:height="24dp" | ||
| android:viewportWidth="24" | ||
| android:viewportHeight="24"> | ||
| <path | ||
| android:pathData="M16,5.814C16.391,5.814 16.705,5.98 16.977,6.188C17.235,6.384 17.518,6.669 17.839,6.99L18.01,7.161C18.331,7.482 18.616,7.766 18.813,8.023C19.02,8.295 19.185,8.609 19.185,9C19.185,9.391 19.02,9.705 18.813,9.977C18.616,10.234 18.331,10.518 18.01,10.839L10.816,18.032C10.644,18.204 10.483,18.373 10.277,18.489C10.072,18.606 9.844,18.658 9.608,18.717L6.954,19.38C6.793,19.42 6.606,19.469 6.448,19.484C6.283,19.5 5.983,19.499 5.742,19.258C5.501,19.017 5.499,18.717 5.516,18.552C5.531,18.394 5.58,18.207 5.62,18.046L6.283,15.392C6.342,15.156 6.394,14.928 6.511,14.723C6.627,14.517 6.796,14.356 6.968,14.184L14.161,6.99C14.482,6.669 14.766,6.384 15.023,6.188C15.295,5.98 15.609,5.814 16,5.814Z" | ||
| android:strokeWidth="1.2" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| <path | ||
| android:strokeWidth="1" | ||
| android:pathData="M13.5,7.5L17.5,11.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| </vector> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| <vector xmlns:android="http://schemas.android.com/apk/res/android" | ||
| android:width="24dp" | ||
| android:height="24dp" | ||
| android:viewportWidth="24" | ||
| android:viewportHeight="24"> | ||
| <path | ||
| android:pathData="M19,16V14C19,11.172 19,9.757 18.121,8.879C17.243,8 15.828,8 13,8H11C8.172,8 6.757,8 5.879,8.879C5,9.757 5,11.172 5,14V16C5,18.828 5,20.243 5.879,21.121C6.757,22 8.172,22 11,22H13C15.828,22 17.243,22 18.121,21.121C19,20.243 19,18.828 19,16Z" | ||
| android:strokeLineJoin="round" | ||
| android:strokeWidth="1.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| <path | ||
| android:pathData="M19,18C20.414,18 21.121,18 21.561,17.561C22,17.121 22,16.414 22,15C22,13.586 22,12.879 21.561,12.439C21.121,12 20.414,12 19,12" | ||
| android:strokeLineJoin="round" | ||
| android:strokeWidth="1.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| <path | ||
| android:pathData="M5,18C3.586,18 2.879,18 2.439,17.561C2,17.121 2,16.414 2,15C2,13.586 2,12.879 2.439,12.439C2.879,12 3.586,12 5,12" | ||
| android:strokeLineJoin="round" | ||
| android:strokeWidth="1.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| <path | ||
| android:pathData="M13.5,3.5C13.5,4.328 12.828,5 12,5C11.172,5 10.5,4.328 10.5,3.5C10.5,2.672 11.172,2 12,2C12.828,2 13.5,2.672 13.5,3.5Z" | ||
| android:strokeWidth="1.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| <path | ||
| android:pathData="M12,5V8" | ||
| android:strokeLineJoin="round" | ||
| android:strokeWidth="1.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff" | ||
| android:strokeLineCap="round"/> | ||
| <path | ||
| android:pathData="M9,13V14" | ||
| android:strokeLineJoin="round" | ||
| android:strokeWidth="1.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff" | ||
| android:strokeLineCap="round"/> | ||
| <path | ||
| android:pathData="M15,13V14" | ||
| android:strokeLineJoin="round" | ||
| android:strokeWidth="1.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff" | ||
| android:strokeLineCap="round"/> | ||
| <path | ||
| android:pathData="M10,17.5C10,17.5 10.667,18 12,18C13.333,18 14,17.5 14,17.5" | ||
| android:strokeWidth="1.5" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff" | ||
| android:strokeLineCap="round"/> | ||
| </vector> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <vector xmlns:android="http://schemas.android.com/apk/res/android" | ||
| android:width="24dp" | ||
| android:height="24dp" | ||
| android:viewportWidth="24" | ||
| android:viewportHeight="24"> | ||
| <path | ||
| android:strokeWidth="1" | ||
| android:pathData="M18,9L12,15L6,9" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| </vector> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <vector xmlns:android="http://schemas.android.com/apk/res/android" | ||
| android:width="24dp" | ||
| android:height="24dp" | ||
| android:viewportWidth="24" | ||
| android:viewportHeight="24"> | ||
| <path | ||
| android:strokeWidth="1" | ||
| android:pathData="M15,6L9,12L15,18" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| </vector> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <vector xmlns:android="http://schemas.android.com/apk/res/android" | ||
| android:width="24dp" | ||
| android:height="24dp" | ||
| android:viewportWidth="24" | ||
| android:viewportHeight="24"> | ||
| <path | ||
| android:strokeWidth="1" | ||
| android:pathData="M9,6L15,12L9,18" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| </vector> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <vector xmlns:android="http://schemas.android.com/apk/res/android" | ||
| android:width="24dp" | ||
| android:height="24dp" | ||
| android:viewportWidth="24" | ||
| android:viewportHeight="24"> | ||
| <path | ||
| android:strokeWidth="1" | ||
| android:pathData="M18,15L12,9L6,15" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| </vector> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <vector xmlns:android="http://schemas.android.com/apk/res/android" | ||
| android:width="24dp" | ||
| android:height="24dp" | ||
| android:viewportWidth="24" | ||
| android:viewportHeight="24"> | ||
| <path | ||
| android:strokeWidth="1" | ||
| android:pathData="M5,14L9,17L18,6" | ||
| android:fillColor="#00000000" | ||
| android:strokeColor="#ffffff"/> | ||
| </vector> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <vector xmlns:android="http://schemas.android.com/apk/res/android" | ||
| android:width="24dp" | ||
| android:height="24dp" | ||
| android:viewportWidth="24" | ||
| android:viewportHeight="24"> | ||
| <path | ||
| android:pathData="M12,14.122L17.303,19.425C17.584,19.706 17.966,19.865 18.364,19.865C18.762,19.865 19.144,19.706 19.425,19.425C19.706,19.144 19.865,18.762 19.865,18.364C19.865,17.966 19.706,17.584 19.425,17.303L14.12,12L19.424,6.697C19.563,6.558 19.674,6.392 19.749,6.21C19.824,6.028 19.863,5.833 19.863,5.636C19.863,5.439 19.824,5.244 19.749,5.062C19.674,4.88 19.563,4.715 19.424,4.575C19.284,4.436 19.119,4.326 18.937,4.25C18.755,4.175 18.56,4.136 18.363,4.136C18.166,4.136 17.971,4.175 17.789,4.251C17.607,4.326 17.441,4.437 17.302,4.576L12,9.879L6.697,4.576C6.559,4.433 6.393,4.318 6.21,4.24C6.027,4.161 5.831,4.119 5.631,4.118C5.432,4.116 5.235,4.154 5.05,4.229C4.866,4.304 4.698,4.416 4.558,4.556C4.417,4.697 4.305,4.865 4.23,5.049C4.154,5.233 4.116,5.431 4.118,5.63C4.119,5.829 4.161,6.026 4.239,6.209C4.318,6.392 4.432,6.558 4.575,6.696L9.88,12L4.576,17.304C4.433,17.442 4.319,17.608 4.24,17.791C4.162,17.974 4.12,18.171 4.119,18.37C4.117,18.569 4.155,18.767 4.231,18.951C4.306,19.135 4.418,19.303 4.559,19.444C4.699,19.584 4.867,19.696 5.051,19.771C5.236,19.846 5.433,19.884 5.632,19.882C5.832,19.881 6.028,19.839 6.211,19.76C6.394,19.682 6.56,19.567 6.698,19.424L12,14.122Z" | ||
| android:fillColor="#ffffff" | ||
| android:fillType="evenOdd"/> | ||
| </vector> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
p3) 이거 내가 domain 빠진 버전으로 다시 노션에 올려줄게 ㅋㅋㅋ.. 까먹고 노션쪽에는 수정을 안했네..