Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nisrulz/android-spacex-app
An Offline first Android app to consume the SpaceX Backend API
https://github.com/nisrulz/android-spacex-app
android cacheing clean-architecture coil delegate-pattern gson hilt-android jetpack-compose jetpack-compose-navigation junit kotlin kotlin-coroutines kotlin-flow mockk mockwebserver offline-first okhttp3 repository-pattern retrofit2 room-database
Last synced: 3 months ago
JSON representation
An Offline first Android app to consume the SpaceX Backend API
- Host: GitHub
- URL: https://github.com/nisrulz/android-spacex-app
- Owner: nisrulz
- License: apache-2.0
- Created: 2023-10-21T23:12:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T03:50:31.000Z (3 months ago)
- Last Synced: 2024-10-24T21:07:53.592Z (3 months ago)
- Topics: android, cacheing, clean-architecture, coil, delegate-pattern, gson, hilt-android, jetpack-compose, jetpack-compose-navigation, junit, kotlin, kotlin-coroutines, kotlin-flow, mockk, mockwebserver, offline-first, okhttp3, repository-pattern, retrofit2, room-database
- Language: Kotlin
- Homepage:
- Size: 972 KB
- Stars: 14
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# SpaceX API Android App
An Offline first Android app to consume the SpaceX Backend API [`https://github.com/r-spacex/SpaceX-API`](https://github.com/r-spacex/SpaceX-API).
---
[](https://github.com/nisrulz/android-spacex-app/actions/workflows/run-tests.yml) [](https://github.com/nisrulz/android-spacex-app/actions/workflows/validate-gradlew.yml) [](https://github.com/nisrulz/android-spacex-app/actions/workflows/gen-android-apk.yml)
> \[!IMPORTANT]
>
> **Star the Repository**: You will receive all update notifications from GitHub without any delay \~ ⭐️
Star History
## Tech Stack
### Core
- [Kotlin](https://kotlinlang.org/)
### Dependency Injection
- [Hilt](https://dagger.dev/hilt/)
### Async Programming
- [Kotlin Coroutines](https://kotlinlang.org/docs/coroutines-overview.html)
- [Kotlin Flow](https://kotlinlang.org/docs/flow.html)
### View
- [Jetpack Compose](https://developer.android.com/jetpack/compose) (Declarative UI Framework)
### Navigation
- [Jetpack Compose Navigation](https://developer.android.com/jetpack/compose/navigation)
- [Type Safe Navigation](https://github.com/nisrulz/android-spacex-app/pull/37)
### Networking
- [Retrofit](https://square.github.io/retrofit/) (REST client)
- [OkHttp](https://square.github.io/okhttp/) (Networking client)
- [KotlinX Serialization](https://github.com/Kotlin/kotlinx.serialization/tree/master) (JSON serialization)
### Local Persistence
- [Room DB](https://developer.android.com/training/data-storage/room) (SQLite ORM)
### Image
- [Coil](https://coil-kt.github.io/coil/) (Image loading libary)
### Testing
- [Truth](https://truth.dev/) (Fluent assertions for Java and Android)
- [Junit](https://junit.org/junit4/) (Unit tests)
- [Turbine](https://github.com/cashapp/turbine) (A small testing library for kotlinx.coroutines Flow)
- [MockWebserver](https://github.com/square/okhttp/tree/master/mockwebserver) (A scriptable web server for testing HTTP clients)
- [MockK](https://mockk.io/) (mocking library for Kotlin)
## App pattern highlights
- [Offline first](https://developer.android.com/topic/architecture/data-layer/offline-first)
- Clean Architecture
- [Repsository](https://developer.android.com/topic/architecture/data-layer)
- Usecases
- [Dependency Injection](https://developer.android.com/training/dependency-injection)
- Declarative UI
- Navigation with args
- Cacheing
- [Delegation](https://kotlinlang.org/docs/delegation.html)
- [Multibindings with Hilt](https://dagger.dev/dev-guide/multibindings.html)
- [Convention Plugins](https://github.com/nisrulz/android-spacex-app/pull/29/commits/2e05a6c3fa972cd29c89a28cb5a735aa073d4f43)
- [Github Actions](https://docs.github.com/en/actions) | [Workflows used](.github/workflows)
## Dependency Graph
> To generate this graph, simply run in the root directory.
>
> ```sh
> cd repo_assets/dependency_graph
> python3 generate_module_dependency_graph.py
> ```
## Project Requirements
- Java 11+
- **Android Studio Giraffe+** (for easy install use [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/))
## How to build?
1. Clone the repository
2. Open with Android Studio
3. Everything should sync and build automatically
## License
- Copyright © 2023 [Nishant Srivastava](https://github.com/nisrulz).
- This project is [Apache License 2.0](./LICENSE) licensed.