Skip to content

Latest commit

 

History

History
116 lines (86 loc) · 3.79 KB

README.md

File metadata and controls

116 lines (86 loc) · 3.79 KB
Raw

Android MVVM Architecture - Modern Approach

Android Unit Test

WhereIsMyMotivation

Cover

This is a complete production ready project to learn modern Android development. It adopts the latest jetpack libraries and is based on MVVM architecture.

Google recommends similar design

App Screenshots

Light

Dark

See More Screenshots here SCREEN_SHOTS.md

Framework

  • MVVM
  • Material Design 3
  • Navigation
  • ViewModel
  • Compose
  • Co-Routines
  • Flow
  • Hilt
  • Retrofit
  • OkHttp
  • Coil
  • Room
  • DataStore
  • Firebase
  • Work Manager
  • Crashlytics
  • Analytics
  • Notifications

Highlights

  • Single Activity
  • Dark and light theme
  • Modular Retrofit architecture
  • SharedFlow for communication
  • Reusable UI components
  • Notification framework
  • Sharing feature
  • 100% Kotlin

About Project

WhereIsMyMotivation is a concept where you see videos and quotes that can inspire you everyday. You will get information on great personalities and make them your perceived mentors. You can also subscribe to topics of your interests.

You can track your happiness level and write down daily journals. You can also share things of interest from web to store in your motivation box.

Using this app can bring a little bit of happiness and energy to live an inspired life.

Detailed Article on this project

Read this article to understand the project structure and concepts used: Android MVVM Architecture for A Production Ready App

Architecture

Architecture

UI Screens

UI-Screens

Installation Instructions

# clone the backend project wimm-node-app used for this App
git clone https://github.com/unusualcodeorg/wimm-node-app.git --recursive

# goto the wimm-node-app and run
npm install

# install and start docker containers (https://docs.docker.com/install)
docker-compose up -d

# clone the wimm-android-app
git clone https://github.com/unusualcodeorg/wimm-android-app.git

# open wimm-android-app in Android Studio and run the app
echo "Enjoy learning Modern Android Development - WhereIsMyMotivation :D"

Important

Change the BASE_URL in app/build.gradle.kts to your local IP address. You can find your local IP address from wifi info or run the following bash command in terminal.

For Linux/macOS:

ifconfig | grep 'inet '

For Windows:

ipconfig | findstr "IPv4" | findstr [0-9]

Example

buildConfigField("String", "BASE_URL", "\"http://192.168.1.6:3000/\"")

Note

  • You may want to replace the app/src/google-services.json with your own firebase project to see the crashlytics and test notifications. Create a firebase project from here: Firebase
  • Run the Backend Project to power this App as mentioned below

Supporting Backend Project

The backend that powers this App is also open-sourced. You can find it here: Modern Backend Development - WhereIsMyMotivation

Find this project useful ? ❤️

  • Support it by clicking the ⭐ button on the upper right of this page. ✌️

More on YouTube channel - Unusual Code

Subscribe to the YouTube channel UnusualCode for understanding the concepts used in this project:

YouTube

Contribution

Please feel free to fork it and open a PR.