Skip to content

Commit 958a988

Browse files
authored
Create README.md
1 parent aa59266 commit 958a988

File tree

1 file changed

+132
-0
lines changed

1 file changed

+132
-0
lines changed

README.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Reed-Android
2+
[![Kotlin](https://img.shields.io/badge/Kotlin-2.2.0-blue.svg)](https://kotlinlang.org)
3+
[![Gradle](https://img.shields.io/badge/gradle-8.11.1-green.svg)](https://gradle.org/)
4+
[![Android Studio](https://img.shields.io/badge/Android%20Studio-2025.1.2%20%28Narwhal%29-green)](https://developer.android.com/studio)
5+
[![minSdkVersion](https://img.shields.io/badge/minSdkVersion-28-red)](https://developer.android.com/distribute/best-practices/develop/target-sdk)
6+
[![targetSdkVersion](https://img.shields.io/badge/targetSdkVersion-35-orange)](https://developer.android.com/distribute/best-practices/develop/target-sdk)
7+
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/YAPP-Github/Reed-Android?utm_source=oss&utm_medium=github&utm_campaign=YAPP-Github%2FReed-Android&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
8+
<br/>
9+
10+
Reed(리드) - 문장과 감정을 함께 담는 독서 기록 [PlayStore](https://play.google.com/store/apps/details?id=com.ninecraft.booket&hl=ko)
11+
<img width="1024" height="500" alt="reed_graphic" src="https://github.com/user-attachments/assets/9e4e6f0a-46b0-4409-b2f9-d3c5f0a3a8b1" />
12+
13+
<p align="center">
14+
<img src="https://github.com/user-attachments/assets/f31d5681-bbf0-4de4-93a6-37a2adf54df7" width="30%"/>
15+
<img src="https://github.com/user-attachments/assets/db92e159-091d-425b-8cc2-2324d4191463" width="30%"/>
16+
<img src="https://github.com/user-attachments/assets/5fd3f726-f493-4850-9d99-3933815dcd8b" width="30%"/>
17+
</p>
18+
<p align="center">
19+
<img src="https://github.com/user-attachments/assets/bb7e3281-c7e4-453d-a921-cc4e9a051434" width="30%"/>
20+
<img src="https://github.com/user-attachments/assets/7c211781-58e5-4413-9f20-f92b1d0c8f24" width="30%"/>
21+
</p>
22+
23+
## Features
24+
25+
## TroubleShooting
26+
- [[Compose] M3 ModalBottomSheet 드래그(터치 이벤트) 막는 법](https://velog.io/@mraz3068/Compose-M3-ModalBottomSheet-Drag-Disabled)
27+
- [Circuit 찍먹해보기(부제: Circuit 희망편)](https://speakerdeck.com/easyhooon/circuit-jjigmeoghaebogi-buje-circuit-hyimangpyeon)
28+
- [Circuit 찍먹해보기(부제: Circuit 절망편)](https://speakerdeck.com/easyhooon/circuit-jjigmeoghaebogi-buje-circuit-jeolmangpyeon)
29+
- [Jetpack Compose에서 CameraX + MLKit으로 OCR을 구현해보자](https://velog.io/@syoon513/Jetpack-Compose%EC%97%90%EC%84%9C-CameraX-MLKit%EC%9C%BC%EB%A1%9C-OCR%EC%9D%84-%EA%B5%AC%ED%98%84%ED%95%B4%EB%B3%B4%EC%9E%90)
30+
- [[Android] 일회성 이벤트를 StateFlow, Compose의 State로 처리할 때 주의해야할 점](https://velog.io/@mraz3068/Handle-One-Time-Event-As-State)
31+
- [Circuit Navigation 사용 시 feature 모듈간의 참조는 어떻게 해결했을까?](https://velog.io/@syoon513/Circuit-Navigation-%EC%82%AC%EC%9A%A9-%EC%8B%9C-feature-%EB%AA%A8%EB%93%88%EA%B0%84-%EC%88%9C%ED%99%98-%EC%B0%B8%EC%A1%B0%EB%8A%94-%EC%96%B4%EB%96%BB%EA%B2%8C-%ED%95%B4%EA%B2%B0%ED%96%88%EC%9D%84%EA%B9%8C)
32+
- [Coroutine 에러 처리 패턴: 여러 API 호출을 한 번에 성공/실패 판정하기](https://velog.io/@syoon513/Coroutine-%EC%98%88%EC%99%B8-%EC%B2%98%EB%A6%AC)
33+
- [[Circuit] ImpressionEffect](https://velog.io/@mraz3068/Circuit-ImpressionEffect)
34+
35+
## Development
36+
37+
### Required
38+
39+
- IDE : Android Studio 최신 버전
40+
- JDK : Java 17을 실행할 수 있는 JDK
41+
- (권장) Android Studio 설치 시 Embeded 된 JDK (Open JDK)
42+
- Java 17을 사용하는 JDK (Open JDK, AdoptOpenJDK, GraalVM)
43+
- Kotlin Language : 2.2.0
44+
45+
### Language
46+
47+
- Kotlin
48+
49+
### Libraries
50+
51+
- AndroidX
52+
- Activity Compose
53+
- Core
54+
- DataStore
55+
- StartUp
56+
- Splash
57+
- Camera
58+
59+
- Kotlin Libraries (Coroutine, Serialization, Immutable Collection)
60+
- Compose
61+
- Material3
62+
63+
- [Circuit](https://github.com/slackhq/circuit)
64+
- Dagger Hilt
65+
- Retrofit, OkHttp
66+
- Coil-Compose, [Landscapist](https://github.com/skydoves/landscapist)
67+
- Google-ML Kit
68+
- Lottie-Compose
69+
- Firebase(Analytics, Crashlytics, Remote Config)
70+
- Kakao-Auth
71+
- [Logger](https://github.com/orhanobut/logger)
72+
- [Compose-Stable-Marker](https://github.com/skydoves/compose-stable-marker)
73+
- [Landscapist](https://github.com/skydoves/landscapist), Coil-Compose
74+
- [ComposeExtensions](https://github.com/taehwandev/ComposeExtensions)
75+
- [compose-effects](https://github.com/skydoves/compose-effects)
76+
- [compose-shadow](https://github.com/adamglin0/compose-shadow)
77+
78+
#### Test & Code analysis
79+
80+
- Ktlint
81+
- Detekt
82+
83+
#### Gradle Dependency
84+
85+
- Gradle Version Catalog
86+
87+
## Architecture
88+
- Android App Architecture
89+
- MVI
90+
91+
## Developers
92+
93+
|Android|Android|
94+
|:---:|:---:|
95+
|[이지훈](https://github.com/easyhooon)|[이서윤](https://github.com/seoyoon513)|
96+
|<img width="144" src="https://github.com/user-attachments/assets/7e54768a-ce44-421d-8c03-9df7d0492855">|<img width="144" src="https://github.com/user-attachments/assets/a6cea688-cf9b-41ad-a3a0-9a0c11775fa2">|
97+
98+
## Module
99+
<img width="1631" height="719" alt="image" src="https://github.com/user-attachments/assets/f6a26dcd-761a-4dab-ae3f-a32e87eb423b" />
100+
101+
## Package Structure
102+
```
103+
├── app
104+
│   └── application
105+
├── build-logic
106+
├── core
107+
│   ├── common
108+
│   ├── data
109+
│   ├── datastore
110+
│   ├── designsystem
111+
│   ├── model
112+
│   ├── network
113+
│   ├── ocr
114+
│   └── ui
115+
├── feature
116+
│   ├── detail
117+
│   ├── edit
118+
│   ├── home
119+
│   ├── library
120+
│   ├── login
121+
│   ├── main
122+
│   ├── onboarding
123+
│   ├── record
124+
│   ├── screens
125+
│   ├── settings
126+
│   ├── splash
127+
│   └── webview
128+
├── gradle
129+
   └── libs.versions.toml
130+
131+
```
132+
<br/>

0 commit comments

Comments
 (0)