An Android StackOverflow client application implemented using the MVVM architecture, Retrofit2, LiveData, Flow, ViewModel, Repository pattern, View Binding. Users can get to view Questions which have been asked on Stack Overflow; picking a particular Question makes the user view it in detail as well as the Answers provided. These Questions can be filtered by any of these four categories; Active, Recent, Hot or Voted. Questions that have an accepted Answer are easily identified. Users can also search for a particular problem they are having by typing in a search query or by capturing an image and performing an OCR on it. Questions are curated based on the search query and presented to the user; again, the user can pick a particular Question to view the provided Answers. Users also have the options to keep a tab on a Tag, filter out questions by Tags, search for any Tag of interest, share questions and answers with themselves or other developers.
- Retrofit which is a type-safe REST client for Android which makes it easier to consume RESTful web services
- Paging Library which helps to load and display small chunks of data at a time
- ViewModel used to store and manage UI-related data in a lifecycle conscious way
- LiveData which is an observable data holder class used to handle data in a lifecycle-aware manner
- Glide which is an image loading and caching library for Android
- Material Design which is an adaptable system that guides in maintaining principles and best practices of contemporary UI
- View Binding used to easily write code that interacts with views by referencing them directly
- Espresso used to write concise, beautiful, and reliable Android UI tests
- MarkdownView which is a simple library that helps to display Markdown text or files on Android as a HTML page just like GitHub
- ML Kit OCR which is a library that recognizes text in any captured image
- Android Image Cropper which is an image cropping library for Android, optimized for camera and gallery.
- Dagger for Dependency Injection
- Kotlin Coroutines for executing network calls asynchronously
- Kotlin flow for emitting live updates from a network call sequentially
- Preferences DataStore for storing and retrieving key-value pairs of primitive data types
This App requires a minimum API level of 26. Clone the repository. You will need an API key from Stack Exchange API to receive a higher request quota. Locate the StringConstants.java file and edit the following line to add your API key:
API_KEY = "YOUR_API_KEY"
All contributions are welcome. See the CONTRIBUTING file for guidelines on contributing
MIT License
Copyright (c) 2021 Joseph Olugbohunmi
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.