Story App

Story App is an application that shows you

Table of Contents

• App Preview
• Features
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Bug Reporting
• Contact
• License

App Preview

Getting Started

Follow these steps to get the app up and running on your Android device or emulator.

Prerequisites

• Android Studio: Download and install the latest version of Android Studio.
• Android Device or Emulator: Ensure you have a physical Android device connected or an emulator set up in Android Studio.

Installation

1. Clone the repository: Clone this repository to your local machine using git.

   git clone https://github.com/onirutlA/Story App.git
   cd Story App

2. Open in Android Studio: Launch Android Studio and select "Open an existing Android Studio project." Navigate to the folder where you cloned the repository and open it.

3. Build and Run: Wait for the project to build, and then click the "Run" button in Android Studio. Select your connected Android device or choose an emulator to run the app.

Library Used

• Kotlin based, Coroutines + Flow for asynchronous.
• Hilt for dependency injection.
• Jetpack
  • Lifecycle - dispose of observing data when lifecycle state changes.
  • ViewModel - UI related data holder, lifecycle aware.
  • Room Persistence - construct the database using the abstract layer.
  • Proto Data Store - Persist user preference
  • Navigation Component - Navigate to another fragment
• Architecture
  • MVI Architecture
  • Repository pattern
  • Multi Module
• Ktor Client & OkHttp3 - construct the REST APIs.
• kotlinx.serialization - A modern JSON library for Kotlin and Java.
• Coil - Image Loading Library.
• UiAutomator
• Paging3
• Google Map
• ArrowKT
• Material-Components - Material design components for building ripple animation, and CardView.

Contributing

Your contributions to this project are highly appreciated! To contribute, follow these steps:

1. Fork the repository and create a new branch.
2. Make your changes and ensure the code is well-tested.
3. Commit your changes and push them to your fork.
4. Submit a pull request, explaining the changes you've made.

Bug Reporting

If you encounter any bugs, issues, or have suggestions for improvements, please open an issue on the repository. Provide as much detail as possible to help us understand and resolve the problem quickly.

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute the app's code following the terms of this license.