Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KDW03 committed Oct 31, 2023
1 parent 2d8c09c commit c9e8c31
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
![image](https://github.com/NaJuDoRyeong/mineme_AOS_new/assets/109224863/91100610-2cfa-434c-9cb9-c5ecaf106e13)


<br>
<br>

## 🌸 프로젝트 소개

소중한 연인과의 추억을 기록해 보세요 🥰
Expand All @@ -11,6 +14,10 @@

위치와 날짜를 기반으로 추억을 모아볼 수 있어요 ☺

<br>
<br>


## 👩‍💻 개발자

<div align="center">
Expand All @@ -21,6 +28,11 @@

</div>


<br>
<br>


## 🛠️ 아키텍처

<img width="850" alt="Untitled" src="https://github.com/NaJuDoRyeong/mineme_AOS_new/assets/109224863/2941a9fb-93f9-4d65-948f-ba2d1ee19afc">
Expand All @@ -30,6 +42,9 @@

전체 구조는 UI Layer과 Data Layer, 두 부분으로 이루어져 있습니다. 각 계층은 자신만의 요소들을 가지고 특정 역할을 합니다. 화살표는 한 요소가 다른 요소에 의존한다는 것을 나타냅니다.


<br>

### **📌 아키텍처 개요**

<img width="569" alt="Untitled" src="https://github.com/NaJuDoRyeong/mineme_AOS_new/assets/109224863/b14886db-d8b8-498b-a676-376ee5c21834">
Expand All @@ -44,6 +59,8 @@
<img width="1819" alt="image" src="https://github.com/NaJuDoRyeong/mineme_AOS_new/assets/109224863/657fd8a0-49f8-4a7d-bee1-310dee857941">


<br>
<br>


## 🪧 모듈화
Expand All @@ -57,6 +74,11 @@
- **feature:Module** - 특정 기능을 담당하는 모듈입니다. 필요할 때 다양한 앱에서 재사용 가능하며, 독립적으로 유지됩니다. 한 클래스가 특정 `feature` 모듈에만 필요하면 그 안에 둬야 합니다. 그렇지 않으면 `core` 모듈로 옮겨야 합니다. `feature` 모듈은 다른 `feature` 모듈에 의존하면 안 되며, `core` 모듈에만 의존해야 합니다.
- **core:Module** - 앱 내에서 공통적으로 사용되는 부분들을 담은 라이브러리 모듈입니다. 다른 `core` 모듈에는 의존할 수 있지만, `feature`이나 `app` 모듈에는 의존하면 안 됩니다.



<br>
<br>

## 🧪 Testing

**Mineme**`Hilt`를 사용한 DI로 testing을 쉽게 합니다.
Expand All @@ -69,6 +91,12 @@
- Instrumentation tests에서, 사용자의 preferences를 임시 폴더에 저장한 후, 테스트가 끝나면 삭제합니다. 이렇게 함으로써 real DataStore의 동작을 모두 테스트할 수 있습니다.
- Test versions의 repositories는 standard repositories와 같은 기능을 제공하며, 추가적인 testing hooks도 제공합니다. 이를 통해 ViewModel의 behavior를 검증합니다.



<br>
<br>


## 🖥️ UI

**Mineme**[Material 3 가이드라인](https://m3.material.io/)을 사용하여 디자인되었습니다.
Expand All @@ -78,6 +106,10 @@
- **동적 색상** - 사용자의 현재 색상 테마를 기반
- **기본 테마** - 동적 색상을 지원하지 않을 때


<br>
<br>

## ©️ License

```
Expand All @@ -96,4 +128,8 @@
limitations under the License.
```


<br>
<br>

## 📚 개발로그

0 comments on commit c9e8c31

Please sign in to comment.