Git Product home page Git Product logo

pokedex's Introduction

Pokédex App

  • Pokédex App built with Kotlin and PokéApi

About Pokédex App 🏻‍💻

Project Description

  • An Android Application which lists Pokémons , using PokéApi ;
  • It scrolls infinitely.
  • One can search pokémons by name or pokémon id
  • One can see the details of each pokémon :
    • Name;
    • Id;
    • Width;
    • Height;
    • Base exp given;
    • Base Stats;
    • Moves list names
  • One can Favourite a Pokémon and see it listed in this webhook page

Tech stack

  • Minimum SDK level 21
  • Kotlin based, Coroutines + Flow for asynchronous.
  • Android JetPack
  • MVVM Architecture (View - Viewbinding - ViewModel - Model)
  • LiveData
  • Navigation
  • ViewModel
  • Viewbinding
  • Retrofit
  • Koin
  • Flow
  • Coroutines
  • PokéApi

Project Approach

I tried to follow MVVM design patterns by using clean code and clean architecture principles. Articles

Since PokeAPI's pokémons listing endpoint, just gives us it's name and respective details url, I had to retrieve pokemons image on it's callback, making other HTTP requests.

For handling pokémons listing, I needed to fetch this list with name/url and, for each result, request it's detail by calling get pokemon details endpoint.

After retrieving every pokemon details, the list was saved on the ViewModel and the UI is updated with the LiveData, a local repository was not created.

For paging handler, it was controlled within the ViewModel, since it's not context-aware. Firstly the offset param which controls paging, was been incremented manually after LiveData's posting values to UI , but I got some thread-related issue which suddenly this increment's were multiplying unnecesarily. So I changed the offset control by retrieving the correct value from the next field returned by PokéAPI , which indicates the url for the next page.

For searching, I made use of Kotlin extension functions for filtering local data while typing. If user submits, pressing enter, it calls getPokemonDetails API for retrieving pokemon info.

Third party libraries used

Thanks

License

   Copyright 2021 Gabriel B Lima

   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.
   

pokedex's People

Contributors

gabrielbrandaodelima avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.