Pokedex is a modern but simple Android app that has the following features:
- Displays a list of all Pokemons
- You can click on a pokemon to see more info on that particular pokemon.
- You can search for a particular pokemon in the searchbar.
The app is built with scalability in mind, using the latest Android developmen practices. It is built using MVVM architecture, and makes use of Modularization.
The app is designed with 4 layers:
- UI layer: Here you have your compose views
- Presentation Layer: Here you have your ViewModels, which are responsible for presenting your data, and handling user input and delegating them to Domain layer & Listen for data
- Domain Layer: Here lies all the Repositories you need for to access your data. They handle traffic from network & storing in local Database. The app also makes use of UseCases to handle user input & Get data.
- Data layer: Here you have your different Datasources. Each Datasource is responsible for accessing data from a different source, such as local database, remote sources, datastore, etc.
The app makes use of modules to split different components into its own module. Why modules? To lower buildtimes, only build the parts you need after making changes to them, to de-couple parts of the app. This makes the app more readable, scalable and testable.
- ✅ Kotlin
- ✅ Compose and Navigation component
- ✅ Coroutines for asynchronous tasks
- ✅ MVVM with jetpack Viewmodel
- ✅ Clean architecture with usecase's and repository pattern
- ✅ Hilt for dependecy injection
- ✅ Room for local database
- ✅ Retrofit for fetching remote data from PokeApi
- ✅ Moshi for JSON operations
- ✅ Coil for image loading
- ✅ Timber for logging
- 🔲 Use of UI, Integration and Unit tests
- 🔲 Modularize by feature
- 🔲 Add newsfeed
- 🔲 Add settings
- 🔲 Add Favourites
- 🔲 Migrate to Paging 3
MIT License
Copyright 2019 AliAmid93
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.