Skip to content

Commit

Permalink
add readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Efimj committed Sep 25, 2024
1 parent 62777be commit ad9e730
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<div align="center">
<img src="./media/gifify.png" width="1920" />
</div>

# Gifify

A Kotlin-based Gif Search app using the Giphy API. Features include auto search, pagination, error handling, and orientation support.

## Features
- **Gif Search**: Fetch and display GIFs from Giphy.
- **Auto Search**: Triggers search after a short delay when typing stops.
- **Pagination**: Loads more results as you scroll.
- **Orientation Support**: Works in both vertical and horizontal modes.
- **Error Handling**: Displays user-friendly error messages.
- **Grid Layout**: Search results displayed in a grid.
- **Gif Detail View**: Opens a detailed view on grid item click.
- **Caching Gif**: Fast access from memory.
- **Loading Indicators**: Shown while fetching data.
- **MVVM Architecture** with Jetpack Compose, Coroutines, and Hilt.
- **Network Handling**: Monitors connectivity and informs users.

## Libraries
- **Retrofit**, **Jetpack Compose**, **Coil**, **Hilt**, **Coroutines**, **ViewModel**, **JUnit**, **Mockito**.

## Setup
1. Clone the repository.
2. Obtain a [Giphy API key](https://developers.giphy.com/).
3. Place the API key in the following file:
`\app\src\main\java\com\yefim\gifsearcher\defaults\Defaults.kt`
4. Build and run the project using Android Studio.


Binary file added media/gifify.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ad9e730

Please sign in to comment.