Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/unusualcodeorg/wimm-android-app

Android MVVM Architecture - Modern Approach - WhereIsMyMotivation - As per Google recommendations. Learn to build a real Android App using latest libraries and techniques.
https://github.com/unusualcodeorg/wimm-android-app

android android-application android-development coil compose coroutines coroutines-flow crashlytics firebase hilt jitpack jitpack-android koltin-android kotlin kotlin-coroutines material3-android mvvm-architecture navigation workmanager

Last synced: 28 days ago
JSON representation

Android MVVM Architecture - Modern Approach - WhereIsMyMotivation - As per Google recommendations. Learn to build a real Android App using latest libraries and techniques.

Host: GitHub
URL: https://github.com/unusualcodeorg/wimm-android-app
Owner: unusualcodeorg
License: apache-2.0
Created: 2023-12-12T11:48:45.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-07-08T19:08:14.000Z (7 months ago)
Last Synced: 2024-12-29T12:12:51.617Z (about 1 month ago)
Topics: android, android-application, android-development, coil, compose, coroutines, coroutines-flow, crashlytics, firebase, hilt, jitpack, jitpack-android, koltin-android, kotlin, kotlin-coroutines, material3-android, mvvm-architecture, navigation, workmanager
Language: Kotlin
Homepage:
Size: 5.72 MB
Stars: 139
Watchers: 4
Forks: 23
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

# Android MVVM Architecture - Modern Approach
[![Android Unit Test](https://github.com/unusualcodeorg/wimm-android-app/actions/workflows/android-unit-test.yml/badge.svg)](https://github.com/unusualcodeorg/wimm-android-app/actions/workflows/android-unit-test.yml)

## WhereIsMyMotivation

![Cover](docs/assets/cover.jpg)

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](docs/screenshots/display-light.png)

![Dark](docs/screenshots/display-dark.png)

See More Screenshots here [SCREEN_SHOTS.md](docs/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](https://medium.com/@janishar.ali/android-mvvm-architecture-for-a-production-ready-app-2892b6dca02f)

## Architecture
![Architecture](docs/assets/arch-comp.svg)

## UI Screens
![UI-Screens](docs/assets/screen-flow.svg)

## Installation Instructions
```bash
# 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:
```base
ifconfig | grep 'inet '
```
For Windows:
```bash
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](https://firebase.google.com)
- 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](https://github.com/unusualcodeorg/wimm-node-app)

## Find this project useful ? :heart:
* Support it by clicking the :star: button on the upper right of this page. :v:

## More on YouTube channel - Unusual Code
Subscribe to the YouTube channel `UnusualCode` for understanding the concepts used in this project:

[![YouTube](https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@unusualcode)

## Contribution
Please feel free to fork it and open a PR.