Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shinhyo committed Sep 8, 2024
1 parent af704cf commit 4087422
Showing 1 changed file with 30 additions and 9 deletions.
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@
## Tech Stack

- [Jetpack](https://developer.android.com/jetpack)
- Compose - Define your UI programmatically with composable functions that describe its shape
and data dependencies.
- Hilt - Extend the functionality of Dagger Hilt to enable dependency injection.
- Lifecycle - Build lifecycle-aware components that can adjust behavior based on the current
lifecycle state
- Room - Create, store, and manage persistent data backed by a SQLite database.
- ViewModel - Store and manage UI-related data in a lifecycle conscious.
- App Startup - initialize components at app startup.
- Compose - Define your UI programmatically with composable functions that describe its shape
and data dependencies.
- Hilt - Extend the functionality of Dagger Hilt to enable dependency injection.
- Lifecycle - Build lifecycle-aware components that can adjust behavior based on the current
lifecycle state
- Room - Create, store, and manage persistent data backed by a SQLite database.
- ViewModel - Store and manage UI-related data in a lifecycle conscious.
- App Startup - initialize components at app startup.
- Clean Architecture (multi module)
- MVVM pattern
- Kotlin
Expand Down Expand Up @@ -65,5 +65,26 @@
   └── setting
```

## Module Graphs
The file structure is similar to Now in Android, but to follow Clean Architecture, the domain layer
does not reference the data layer.

## Nested NavHosts

```mermaid
graph TD
A[Main NavHost] --> B[BottomBar]
A --> C[Detail]
B --> D[Bottom NavHost]
D --> E[List]
D --> F[Favorite]
D --> G[Setting]
```

Even though using nested NavHosts makes things more complex, this approach was chosen to achieve screen transition animations similar to those between Activities.

(One NavHost needs to manage how to hide the bottom navigation and apply animations during screen transitions.)

# Module Graphs

![](project.dot.png)

0 comments on commit 4087422

Please sign in to comment.