josephsarz / news-sample-app

A sample news app which demonstrates clean architecture and best practices for developing android app

Android News Clean Architecture

Things achieved so far

1. Clean architecture using kotlin
2. Presentation layer using MVVM
3. Using Koin for dependency resolution
4. Single source of truth with Room
5. CircleCi

RoadMap for future

1. Pagination
2. Coroutines
3. Dynamic feature
4. Unit test
5. UI Improvement

Steps to run:

1. Generate api key from https://newsapi.org/
2. Put the api key in presentation layer gradle file as a value to API_KEY

Features

1. Clean architecture with coroutines: https://github.com/rakshit444/news-sample-app/tree/wip/coroutines

Posting

Clean architecture: https://medium.com/@rjain.jain444/kotlin-clean-architecture-1ad42fcd97fa
Coroutines: https://proandroiddev.com/experimenting-with-coroutines-2082d5ec4ae8

Developed By

• Rakshit Jain - [email protected]

License

Copyright 2019 Rakshit Jain

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.