-
Notifications
You must be signed in to change notification settings - Fork 0
[Docs]: 리드미 작성 #193
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
[Docs]: 리드미 작성 #193
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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,74 @@ | ||
| # Flint-Android | ||
| 플린트 안드로이드 레포지토리입니다 | ||
| # 🎬 Flint | ||
|
|
||
| > OTT 콘텐츠 추천 및 관리 플랫폼 | ||
|
|
||
| FLINT는 알고리즘 대신 누군가의 시선과 맥락이 담긴 **컬렉션**을 통해 시청 동기를 자극하는 OTT 콘텐츠 탐색 서비스입니다. 작품의 단순 정보가 아닌 **매력 포인트**에 집중한 큐레이션으로 정보 과잉에 지친 사용자의 탐색 피로를 획기적으로 줄여줍니다. 사용자는 끌리는 컬렉션을 수집하고 직접 생성하며, 파편화된 시청 이력을 나만의 고유한 **취향 키워드**로 축적할 수 있습니다. 단순히 볼거리를 추천하는 것을 넘어, 사용자가 스스로 '무엇에 끌리는 사람인지' 발견하고 정의하는 경험을 제공합니다. | ||
|
|
||
| <br/> | ||
|
|
||
| ## 👥 Contributors | ||
| | <img src="https://github.com/user-attachments/assets/2a7ce16b-46f6-4447-920b-6692ad594d04" width="140" /> | <img src="https://github.com/user-attachments/assets/b0a27858-6ad2-47c5-af32-1981e05292f8" width="140" /> | <img src="https://github.com/user-attachments/assets/76065ce6-2098-44bd-8c61-c4cf8b86cca7" width="140" /> | <img src="https://github.com/user-attachments/assets/8340174d-c7ab-4c0d-95bd-d56af5d2b916" width="140" /> | <img src="https://github.com/user-attachments/assets/2d4fe236-ea88-43b6-b40e-d8e041d2cbe1" width="140" /> | | ||
| |:---:|:---:|:---:|:---:|:---:| | ||
| | **[김나현](https://github.com/nahy-512)** | **[김종우](https://github.com/kimjw2003)** | **[박찬미](https://github.com/chanmi1125)** | **[임차민](https://github.com/ckals413)** | **[김준서](https://github.com/giovannijunseokim)** | | ||
| | 프로필, 컬렉션 목록 | 홈, 로그인 | 컬렉션 생성 | 스플레시, 온보딩 | 탐색, 컬렉션 상세 | | ||
|
|
||
| <br/> | ||
|
|
||
| ## 🛠 Tech Stack | ||
|
|
||
| ### Architecture | ||
| - **Google App Architecture** (Data - Domain - Presentation) | ||
| - **MVVM Pattern** | ||
| - **Repository Pattern** | ||
|
|
||
| ### Android | ||
| - **Language**: Kotlin | ||
| - **UI**: Jetpack Compose | ||
| - **Dependency Injection**: Hilt | ||
| - **Asynchronous**: Coroutines, Flow | ||
| - **Network**: Retrofit, OkHttp, kotlinx.serialization | ||
| - **Local Storage**: DataStore | ||
| - **Navigation**: Type-safe Navigation Component | ||
|
|
||
| ## 📦 Project Structure | ||
| ``` | ||
|
|
||
| com.flint/ | ||
| ├── core/ | ||
| │ ├── common/ | ||
| │ │ ├── di/ | ||
| │ │ ├── datastore/ | ||
| │ │ ├── extension/ | ||
| │ │ ├── manager/ | ||
| │ │ └── util/ | ||
| │ ├── designsystem/ | ||
| │ │ ├── theme/ | ||
| │ │ └── component/ | ||
| │ └── navigation/ | ||
| │ | ||
| ├── data/ | ||
| │ ├── api/ | ||
| │ ├── dto/ | ||
| │ │ ├── base/ | ||
| │ │ └── {feature}/ | ||
| │ │ ├── request/ | ||
| │ │ └── response/ | ||
| │ ├── di/ | ||
| │ └── local/ | ||
| │ | ||
| ├── domain/ | ||
| │ ├── model/ | ||
| │ ├── mapper/ | ||
| │ ├── repository/ | ||
| │ └── type/ | ||
| │ | ||
| └── presentation/ | ||
| └── {feature}/ | ||
| ├── *Route.kt | ||
| ├── *Screen.kt | ||
| ├── *ViewModel.kt | ||
| └── *UiState.kt | ||
| ``` | ||
|
|
||
| ## Flint 코드/ 깃/ 브랜치 컨벤션 | ||
| https://ckals413.notion.site/Flint-2f17f139a61a80268a92cd07adc59f90?source=copy_link | ||
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.
기여자 GitHub 링크와 접근성 개선이 필요합니다.
현재 GitHub 링크가 플레이스홀더(
contributor1,contributor2등)로 되어 있어 실제 프로필로 연결되지 않습니다. 실제 GitHub 사용자명으로 업데이트해주세요.또한 이미지에 대체 텍스트(alt text)를 추가하면 스크린 리더 사용자의 접근성이 향상됩니다.
♻️ 제안하는 수정안
참고: 실제 GitHub 사용자명으로 교체해주세요.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
10-10: Images should have alternate text (alt text)
(MD045, no-alt-text)
10-10: Images should have alternate text (alt text)
(MD045, no-alt-text)
10-10: Images should have alternate text (alt text)
(MD045, no-alt-text)
10-10: Images should have alternate text (alt text)
(MD045, no-alt-text)
10-10: Images should have alternate text (alt text)
(MD045, no-alt-text)
10-10: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🤖 Prompt for AI Agents