Contact Keeper is an Android application that allows users to manage their contacts efficiently. It supports adding, editing, and deleting contacts, as well as assigning a profile photo to each contact. The app is built using MVVM architecture with Dependency Injection and Room database. It utilizes Material3 for a modern and cohesive UI design.
You can download the latest version by clicking the button below.
- Add Contacts: Add new contacts with name, phone number, email, and profile photo.
- Edit Contacts: Edit existing contacts' details.
- Delete Contacts: Remove contacts from the list.
- Profile Photo: Assign and display profile photos for each contact.
- MVVM Architecture: Follows MVVM architecture for a clean and maintainable codebase.
- Room Database: Uses Room database for local storage of contacts.
- Material3 UI: Modern UI components using Material3.
- Clone the repository:
git clone https://github.com/GeniusApk/contactkeeper.git
- Open the project in Android Studio.
- Build and run the app on your Android device or emulator.
ContactKeeper/
├── .gitignore
├── build.gradle.kts
├── gradle.properties
├── gradlew
├── gradlew.bat
├── settings.gradle.kts
├── app/
│ ├── .gitignore
│ ├── build.gradle.kts
│ ├── proguard-rules.pro
│ ├── src/
│ │ ├── androidTest/
│ │ │ └── java/
│ │ │ └── com/
│ │ │ └── geniusapk/
│ │ │ └── contactkeeper/
│ │ │ └── ExampleInstrumentedTest.kt
│ │ ├── main/
│ │ │ ├── AndroidManifest.xml
│ │ │ ├── ic_launcher-playstore.png
│ │ │ ├── java/
│ │ │ │ └── com/
│ │ │ │ └── geniusapk/
│ │ │ │ ├── BaseApplication.kt
│ │ │ │ ├── MainActivity.kt
│ │ │ │ ├── data/
│ │ │ │ │ ├── test
│ │ │ │ │ └── database/
│ │ │ │ │ ├── Contact.kt
│ │ │ │ │ ├── ContectDataBase.kt
│ │ │ │ │ └── Dao.kt
│ │ │ │ ├── di/
│ │ │ │ │ └── HiltModule.kt
│ │ │ │ ├── navigation/
│ │ │ │ │ ├── NavGraph.kt
│ │ │ │ │ └── Routes.kt
│ │ │ │ ├── presentation/
│ │ │ │ │ ├── ContactState.kt
│ │ │ │ │ ├── ContactViewModel.kt
│ │ │ │ │ ├── Screens/
│ │ │ │ │ │ ├── AddEditScreen.kt
│ │ │ │ │ │ └── HomeScreen.kt
│ │ │ │ │ └── Utils/
│ │ │ │ │ ├── CustemTextField.kt
│ │ │ │ │ └── ImageCompress.kt
│ │ │ │ └── ui/
│ │ │ │ └── theme/
│ │ │ │ ├── Color.kt
│ │ │ │ ├── Theme.kt
│ │ │ │ └── Type.kt
│ │ │ └── res/
│ │ │ ├── drawable/
│ │ │ │ ├── ic_launcher_background.xml
│ │ │ │ └── ic_launcher_foreground.xml
│ │ │ ├── mipmap-anydpi/
│ │ │ ├── mipmap-anydpi-v26/
│ │ │ │ ├── ic_launcher.xml
│ │ │ │ └── ic_launcher_round.xml
│ │ │ ├── mipmap-hdpi/
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── mipmap-mdpi/
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── mipmap-xhdpi/
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── mipmap-xxhdpi/
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── mipmap-xxxhdpi/
│ │ │ │ ├── ic_launcher.webp
│ │ │ │ └── ic_launcher_round.webp
│ │ │ ├── values/
│ │ │ │ ├── colors.xml
│ │ │ │ ├── ic_launcher_background.xml
│ │ │ │ ├── strings.xml
│ │ │ │ └── themes.xml
│ │ │ └── xml/
│ │ │ ├── backup_rules.xml
│ │ │ └── data_extraction_rules.xml
│ │ └── test/
│ │ └── java/
│ │ └── com/
│ │ └── geniusapk/
│ │ └── contactkeeper/
│ │ └── ExampleUnitTest.kt
├── gradle/
│ ├── libs.versions.toml
│ └── wrapper/
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
The app uses the following dependencies:
- AndroidX Libraries: For backward compatibility and modern Android development.
- Jetpack Compose: For building the UI.
- Hilt: For dependency injection.
- Room: For local database storage.
- Material Components: For modern UI components using Material3.
Add these dependencies in your build.gradle.kts file:
dependencies {
implementation("androidx.core:core-ktx:1.7.0")
implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.4.0")
implementation("androidx.activity:activity-compose:1.4.0")
implementation("androidx.compose.ui:ui:1.1.0")
implementation("androidx.compose.material3:material3:1.0.0-alpha01")
implementation("com.google.dagger:hilt-android:2.40.5")
kapt("com.google.dagger:hilt-compiler:2.40.5")
implementation("androidx.room:room-runtime:2.4.0")
kapt("androidx.room:room-compiler:2.4.0")
implementation("androidx.navigation:navigation-compose:2.4.0-alpha10")
}The home screen of the app displays a list of contacts with their respective details:
- Contact Details Displayed: Each contact card shows the name, phone number, email, and profile photo.
- Actions Available:
- Add a new contact: Click the floating action button with the '+' icon.
- Edit a contact: Tap on the contact card to navigate to the edit screen.
- Delete a contact: Click the delete icon on the contact card.
- Call a contact: Click the call icon on the contact card.
The add/edit screen enables users to manage contact details:
- Data Entry Fields:
- Enter Name: Type the contact's name.
- Enter Phone Number: Type the contact's phone number.
- Enter Email: Type the contact's email address.
- Add/Update Profile Photo: Click on the profile photo placeholder to choose an image from your device.
- Save Contact: After entering or updating details, click the 'Save' button to save the contact.
The app follows the MVVM (Model-View-ViewModel) architecture pattern:
- Model: Represents the data and business logic. It includes Room database entities and DAOs.
- ViewModel: Acts as a mediator between the View (UI) and Model. It manages UI-related data and communicates with the backend or repository.
- View: The UI layer built using Jetpack Compose, which displays data and interacts with users.
Dependency injection using Hilt is utilized to manage app dependencies:
- Purpose: Helps in creating a modular and testable codebase by providing dependencies to classes.
- Advantages: Enhances code readability, maintainability, and scalability.
Room is employed for local database operations:
- Functionality: Provides an abstraction layer over SQLite for efficient storage and management of contacts locally.
- Advantages: Enables seamless data handling operations like insertion, deletion, and updating of contact records.
This project is licensed under the MIT License. For details, see the LICENSE file.
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature-branch
- Commit your changes:
git commit -m 'Add new feature' - Push to the branch:
git push origin feature-branch
- Open a pull request.
This project is licensed under the MIT License. See the LICENSE file for more information.
For any inquiries or issues, please contact [mohd.aakib208381@gmail.com].