Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/malekkamel/contacts
A sample Android project for Kotlin, MVVM, clean code, modular architecture, Room, ContentProvider, unit testing, and WorkManager.
https://github.com/malekkamel/contacts
android android-app android-application android-studio architecture-components clean-architecture clean-code gradle java java-8 kotlin modular modularization modules mvvm viewmodel workmanager
Last synced: 5 days ago
JSON representation
A sample Android project for Kotlin, MVVM, clean code, modular architecture, Room, ContentProvider, unit testing, and WorkManager.
- Host: GitHub
- URL: https://github.com/malekkamel/contacts
- Owner: MalekKamel
- Created: 2021-06-17T17:26:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-02T21:41:55.000Z (over 2 years ago)
- Last Synced: 2024-11-29T03:16:36.723Z (2 months ago)
- Topics: android, android-app, android-application, android-studio, architecture-components, clean-architecture, clean-code, gradle, java, java-8, kotlin, modular, modularization, modules, mvvm, viewmodel, workmanager
- Language: Kotlin
- Homepage:
- Size: 804 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contacts
Contacts app represents a real world app example: it provides a fairly complex set of functionalities,
it's a suitable showcase for all the advantages that architecture components bring,
has all features that would make it a modular, scalable, testable and maintainable app.
## App Logic
- The app displays the list of user’s contacts that are saved in `Room` local database.
- If there's no data in `Room`, it will be retrieved from contacts `ContentPorvider` and saved locally in `Room`.
- The local contacts are synchronized with `ContentPorvider` in background every 15 minutes using `WorkManager`.
- The local contacts are synchronized every time the user opens the app.
## Modular Architecture
The app is divided into 3 modules under `common` package. Each package has its own responsibilities.
### Core
Core module contains all shared classes that are visible to all modules.
Here we put all the code that we need to share with any module in the app.
### Data
Data module contains any classes related to the data in the app.
It contains network, local database, SharedPreferences, model classes, and any data-related classes.
### Presentation
Presentation modules contains all UI classes
including view models, base activities, base fragments, custom views, and other common views.
## Google Architecture Components
The app implements Google architecture components. Visit the [Guide](https://developer.android.com/jetpack/docs/guide) for the details.
## Unit Tests
You can find tests in `app` and `data' modules.
## README
Each module has its own `README.md` file that documents the module responsibilities.
### Credit
- [ ] [Build a Modular Android App Architecture (Google I/O'19)](https://www.youtube.com/watch?v=PZBg5DIzNww)
- [ ] [Plaid](https://github.com/android/plaid)
### 🛡 License
Click to reveal License
```
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```