patilshreyas/foodium

🍲Foodium is a sample food blog Android application 📱 built to demonstrate the use of Modern Android development tools - (Kotlin, Coroutines, Flow, Dagger 2/Hilt, Architecture Components, MVVM, Room, Retrofit, Moshi, Material Components).

Foodium 🍲 

Foodium is a sample food blog 🍲 Android application 📱 built to demonstrate use of Modern Android development tools. Dedicated to all Android Developers with ❤️.

You can Install and test latest Foodium app from below 👇

About

It simply loads Posts data from API and stores it in persistence storage (i.e. SQLite Database). Posts will be always loaded from local database. Remote data (from API) and Local data is always synchronized.

• This makes it offline capable 😃.
• Clean and Simple Material UI.
• It supports dark theme too 🌗.

Dummy API is used in this app. JSON response is statically hosted here.

Built With 🛠

• Kotlin - First class and official programming language for Android development.
• Coroutines - For asynchronous and more..
• Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
• Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
  • LiveData - Data objects that notify views when the underlying database changes.
  • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
  • ViewBinding - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
  • Room - SQLite object mapping library.
• Dependency Injection -
  • Hilt-Dagger - Standard library to incorporate Dagger dependency injection into an Android application.
  • Hilt-ViewModel - DI for injecting ViewModel.
• Retrofit - A type-safe HTTP client for Android and Java.
• Moshi - A modern JSON library for Kotlin and Java.
• Moshi Converter - A Converter which uses Moshi for serialization to and from JSON.
• Coil-kt - An image loading library for Android backed by Kotlin Coroutines.
• Material Components for Android - Modular and customizable Material Design UI components for Android.
• Gradle Kotlin DSL - For writing Gradle build scripts using Kotlin.

Lint ✅

This project uses GitHub Super Linter which is Combination of multiple linters to install as a GitHub Action.

Following Linters are used internally by super linter (enabled for this project):

• XML: LibXML
• Kotlin: ktlint

Dagger (Old) DI Version 🗡️

If you want to refer old way of Dependency Injetion using Dagger2, see branch dagger2-di

Koin DI Version 🗡️

If you want to use Koin - Dependency Injection framework in app then visit below repository.

Contributed By: Pranay Patel

Package Structure

dev.shreyaspatil.foodium    # Root Package
.
├── data                # For data handling.
│   ├── local           # Local Persistence Database. Room (SQLite) database
|   │   ├── dao         # Data Access Object for Room   
│   ├── remote          # Remote Data Handlers     
|   │   ├── api         # Retrofit API for remote end point.
│   └── repository      # Single source of data.
|
├── model               # Model classes
|
├── di                  # Dependency Injection             
│   ├── builder         # Activity Builder
│   ├── component       # DI Components       
│   └── module          # DI Modules
|
├── ui                  # Activity/View layer
│   ├── base            # Base View
│   ├── main            # Main Screen Activity & ViewModel
|   │   ├── adapter     # Adapter for RecyclerView
|   │   └── viewmodel   # ViewHolder for RecyclerView   
│   └── details         # Detail Screen Activity and ViewModel
|
└── utils               # Utility Classes / Kotlin extensions

Architecture

This app uses MVVM (Model View View-Model) architecture.

Contribute

If you want to contribute to this library, you're always welcome! See Contributing Guidelines.

Discuss 💬

Have any questions, doubts or want to present your opinions, views? You're always welcome. You can start discussions.

Contact

If you need any help, you can connect with me.

Visit:- shreyaspatil.dev

License

MIT License

Copyright (c) 2020 Shreyas Patil

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

foodium's Issues

Crash happens when tapping on any item.

I am running the app on Nexus 5 android version 6.01 and when on I tap on any item in the food list, instead of showing the detail page, below crash happens:

07-03 21:58:10.930 2289-2289/dev.shreyaspatil.foodium E/AndroidRuntime: FATAL EXCEPTION: main
    Process: dev.shreyaspatil.foodium, PID: 2289
    android.content.res.Resources$NotFoundException: Resource ID #0x7f070080
        at android.content.res.Resources.getValue(Resources.java:1351)
        at androidx.appcompat.widget.ResourceManagerInternal.loadDrawableFromDelegates(ResourceManagerInternal.java:252)
        at androidx.appcompat.widget.ResourceManagerInternal.getDrawable(ResourceManagerInternal.java:139)
        at androidx.appcompat.widget.ResourceManagerInternal.getDrawable(ResourceManagerInternal.java:132)
        at androidx.appcompat.content.res.AppCompatResources.getDrawable(AppCompatResources.java:104)
        at androidx.appcompat.view.menu.MenuItemImpl.getIcon(MenuItemImpl.java:505)
        at androidx.appcompat.view.menu.ActionMenuItemView.initialize(ActionMenuItemView.java:126)
        at androidx.appcompat.widget.ActionMenuPresenter.bindItemView(ActionMenuPresenter.java:207)
        at androidx.appcompat.view.menu.BaseMenuPresenter.getItemView(BaseMenuPresenter.java:188)
        at androidx.appcompat.widget.ActionMenuPresenter.getItemView(ActionMenuPresenter.java:193)
        at androidx.appcompat.widget.ActionMenuPresenter.flagActionItems(ActionMenuPresenter.java:473)
        at androidx.appcompat.view.menu.MenuBuilder.flagActionItems(MenuBuilder.java:1182)
        at androidx.appcompat.view.menu.BaseMenuPresenter.updateMenuView(BaseMenuPresenter.java:96)
        at androidx.appcompat.widget.ActionMenuPresenter.updateMenuView(ActionMenuPresenter.java:226)
        at androidx.appcompat.view.menu.MenuBuilder.dispatchPresenterUpdate(MenuBuilder.java:298)
        at androidx.appcompat.view.menu.MenuBuilder.onItemsChanged(MenuBuilder.java:1069)
        at androidx.appcompat.view.menu.MenuBuilder.startDispatchingItemsChanged(MenuBuilder.java:1096)
        at androidx.appcompat.app.ToolbarActionBar.populateOptionsMenu(ToolbarActionBar.java:461)
        at androidx.appcompat.app.ToolbarActionBar$1.run(ToolbarActionBar.java:56)
        at android.os.Handler.handleCallback(Handler.java:739)
        at android.os.Handler.dispatchMessage(Handler.java:95)
        at android.os.Looper.loop(Looper.java:148)
        at android.app.ActivityThread.main(ActivityThread.java:5417)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:726)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:616)

.idea and apk folders should be ignored by git

It seems .idea folder not ignored by git we need to add it to .gitignore.
Because it will always changes every time we open Android Studio.
It's should be ignored because we don't want to add changes that we are not making.

e.g. misc.xml

And also apk should not be in repo because if we build it again it will detect it as change. It is unnecessary to put apk in git repo. This will make repo size bigger to clone because we need to download the apk too.

Link the project with fire base and add more fuctions

we can link the project to firebase and let users insert there own recipes and show them to the user so you can make it more dynamic

Animated splash screen

The static logo can be replaced with a small animation. Can I work on this ?

DARK THEME ISSUE

I had converted ge the theme in to Dark..Then after reopen the theme again going to white.

Support cool and interactive animations/transitions with MotionLayout

Proposed change

• Support for some cool, interactive animations/transitions using MotionLayout.
• This change is encouraged during "Hacktoberfest" for the participants of this event.

References

• https://medium.com/google-developers/introduction-to-motionlayout-part-i-29208674b10d
• https://developer.android.com/training/constraint-layout/motionlayout

Unable to switch back to light theme after switching to dark

The button from the menu doesn't seem to switch back to light theme once switched to dark theme

Add More Screens

Have to add more screens in this app (currently it's single screen app).

• DetailView - On Clicking blog of MainActivity user should see this screen.

Running dao tests runs forever

While running tests for PostsDaoTest the tests keeps running without completing. But if i test with normal flow builder emitting item and asserting inside run blocking it completes and tests pass.

    val flow =  flow {
        emit(1)
    }

    assertThat(1, equalTo(flow.first()))

The above works inside runBlocking.

I found nothing similar to this issue on internet. Running on latest android studio. Am i missing anything

dev branch missing

Hi,

Cool project thanks for sharing.

Just checked Contributions guidelines and you mention dev branch but
I guess you 've forgot to push it ?

EDIT: Unless you meant master ?

Use `distinctUntilChanged()` in DAO

Should we not use distinctUntilChanged() in dao?.

      @Query("SELECT * FROM ${Post.TABLE_NAME} WHERE ID = :postId")
      fun getPostById(postId: Int): Flow<Post>

      fun getPostByIdUntilChanged(id: Int) = getPostById(id).distinctUntilChanged()

cause if we update a unrelated row the query also emits data with the same result again. https://medium.com/androiddevelopers/room-flow-273acffe5b57

Originally posted by @raghunandankavi2010 in #61

Use the Android Sharesheet for a more modern looking share tray

Describe the bug/request
Use the Android Sharesheet to provide the share functionality, allowing for a more modern looking share menu on Android 10 (API level 29) and above. This will also add the ability to show rich content to previews.

So the UI for the share tray could something like this post this change:

Additional context
Essentially, the following change will be done:

For all types of sharing, create an intent and set its action to Intent.ACTION_SEND. In order to display the Android Sharesheet you need to call Intent.createChooser() , passing it your Intent object. It returns a version of your intent that will always display the Android Sharesheet.

Source: link

Add Searchview filter

how to add filter the item list?

adds share for both share app and share blog detailes

adds share the whole app and share the title, body, and writer of the blog.

make details of the dish shareable

share dish details to social media by providing a button for that.
@PatilShreyas
@pandubaraja

Use room suspending functions

Use room inbuilt support for coroutines
Currently, the code does not use the functionality provided by the Room library. Instead, it uses Dispatchers.IO for threading purposes. I intend to remove this and add inbuilt support.

Proposed changes:
proposed PR

NetworkInfo is deprecated

NedtworkInfo,activeNetworkInfo and isConnectedOrConnecting are deprecated in NetWorkUtlits class

Update README.md

Describe the bug/request
Hi @PatilShreyas
There is a scope of improvements in the README.md file and i would like to update it .
For eg : "This makes it offline capable 😃." can be replaced with "This allows us to use it offline 😃".
Changes like this will be appealing to the readers and will explain the project in a better manner.
I would like to work on this issue so please can you assign this to me.

Additional context
Add any other context about the problem here.

How to use networkBoundRepositroy with out a offline support(Not a issue, for more knowledge)

hai, i follow your code style in my project. so i want to use a api call available only in online.
how it is possible using networkboundRepository

Allways state is succesfull

Due to this code state always succesfull,

emitAll(fetchFromLocal().map {
           State.success<RESULT>(it)
       })

so after internet connection is back,

     ```
if (mViewModel.postsLiveData.value is State.Error || mAdapter.itemCount == 0) {
                    getPosts()
                }

this block of code does not work...
what i can do fetch new result when immediately the connection is back,

Visitable Pattern RecyclerView

Hi @PatilShreyas how about we improve the PostListAdapter with Visitable Pattern? So we can add view items more dynamically in the app and create the factory for the ViewHolders.

And also I think setPosts function in PostListAdapter should not use notifyDataSetChanged to update the list, if we use that the DiffUtil.ItemCallback will become useless because the adapter will re-render the all items which resulted in blinking page.

Instead we could use submitList(items) provided by ListAdapter that PostListAdapter extends to only re-render the items which data have changed with the correct animation.

Thank you 🙏

Ref: https://proandroiddev.com/writing-better-adapters-1b09758407d2

Doubt

First of all, awesome repository. Got a lot to learn in it. 😃

I've a doubt in your code.

Here,

Foodium/app/src/main/java/dev/shreyaspatil/foodium/data/repository/NetworkBoundRepository.kt

Lines 93 to 94 in 75e4541

	@MainThread
	protected abstract suspend fun fetchFromRemote(): Response<REQUEST>

,

Why did you marked fetchFromRemote with @MainThread ? Should it be called from WorkerThread? 🤔

Where can I find the API?

Deprecated JUnit AssertThat()

Describe the bug/request
JUnit "AssertThat" is deprecated use Google Truth instead of that.

Additional context
In FoodiumServiceTest class the JUnit assertThat is used.
Please use google truth instead of this.

Emit Network Response directly without saving the data.

There will be a scenario in which we won't need to save the data to database and use values directly from the network.
Can you share a similar version of NetworkBoundRepository to perform the same.

Wrong APK URL in readme

The APK download in https://github.com/PatilShreyas/Foodium/blob/master/README.md points to https://github.com/patilshreyas/gitktdroid/releases/latest/download/app.apk which is for https://github.com/patilshreyas/gitktdroid/ repo.

I am guessing this is not intentional?

link in the food blog

how can the author add link to different types related pdf in the food blog section

Implementation using Jetpack Compose

Proposed change

• Demo implementation of Foodium app using Jetpack compose will be simply awesome.
• This change is encouraged during "Hacktoberfest" for the participants of this event.

References

• Jetpack Compose | Android Developers
• Jetpack Compose Basiccs

Testing Part Completion

Unit testing and Instrumentation testing is remaining. That should be done.

[FIX] Changing runBlocking to runBlockingTest in Test

Foodium/app/src/test/java/dev/shreyaspatil/foodium/data/remote/api/FoodiumServiceTest.kt

Line 77 in 7da456f

fun getPostsTest() = runBlocking {

As you need synchronous execution in test, and the recommended way is to call runBlockingTest , It should be runBlockingTest instead runBlocking , right ?

how to build this project in android studio

Describe the bug/request
well, i am new to kotlin and android development. if i opened this project in the android studio how to run it