Pokédex using Jetpack Compose

A Pokémon list project that exhibits the next generation way for us to build our multi-module Android Applications using Kotlin 2.0.0, Jetpack Compose, Hilt, Clean Architecture, and more...

Overview

This project will be helpful for many things both Pokémon and Tech, building with Jetpack Compose

Pokédex Features

• List of Pokémon: #1010 as of the moment since the 5 others are newly released no further info is provided
• Shiny Pokémon Image: Get to see what their shiny form looks like in the details page
• Search Pokémon: Either search by their name or number
• Responsive Layout: Supports both portrait and landscape orientation
• Android OS Support: Supports Android Phones starting Nougat (Android 7.0 API Level 24) onwards

Tech Features

• Multi-module: App is multi-module ready to better isolate feature and layer modules that can be handled by big teams. Better way to reuse certain feature and spend less on build times as well
• Clean Architecture: Uses modern android way of building using Clean Architecture

Each feature module is built with a sub-module that follows Domain, Data and UI

• Navigation Across Multi-module Features: Access different features from different module using composables
• Navigation Compose Deeplinks: Shows an example on how to achieve deeplinks, parameterized deeplinks in Navigation Compose

Can be tested using Firefox Android App Home or Main page use: pokedex:// or any other such as pokedex://home Details page use: pokedex://pokemon/{id} where id is the pokemon number

• Coil Image Loading: Attempt to load an image using Coil with or without loading animation
• CI/CD Using Github: Utilizing Github Actions and Github Releases page for pipelines and deployment (uses debug apk but you can build release or sign as you like)
• R8: Release and R8 ready, just make sure to generate your own keystore / signing capability
• Lib Versions Catalog: Uses new lib.versions.toml versions catalog to manage dependencies and their versions

Built With

This project is built using next generation tools supported by the latest Canary version of Android Studio Koala Feature Drop | 2024.1.2 Canary 2:. Kotlin 2.0.0 with Compose Compiler Gradle Ready!

• Android Studio Koala: IDE used
• Kotlin: Programming Language
• K2 Compiler: Enabled
• KSP: Uses KSP for hilt
• Jetpack Compose: UI Toolkit
• Jetpack Libraries: Lifecycle, View Model, Material 3, Navigation Compose etc.
• Hilt: Dependency Injection
• Coil: Image Loading
• Retrofit & OkHttp: Networking and API management
• Kotlin Coroutines & Kotlin Flow: Asynchrounous tasks and management

Credits

• Artwork and UI mockup reference: https://dribbble.com/shots/16833947-Mobile-Pokedex-App-Design-Exploration
• API and Splashscreen Icon: https://pokeapi.co/
• Splashscreen Main Icon: https://icon-library.com/icon/pokedex-icon-21.html
• App Launcher Icon: https://dribbble.com/shots/2947190-Poke-Ball-Pokedex

License

Copyright 2023 Mike Lau

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.