Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ValterKasper/space-app

An Android app which shows timeline of upcoming rocket launches and showcases architecture of real application.
https://github.com/ValterKasper/space-app

android architecture coroutines dagger

Last synced: 3 months ago
JSON representation

An Android app which shows timeline of upcoming rocket launches and showcases architecture of real application.

Host: GitHub
URL: https://github.com/ValterKasper/space-app
Owner: ValterKasper
License: apache-2.0
Created: 2020-04-06T17:34:44.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-07-23T10:10:21.000Z (over 2 years ago)
Last Synced: 2024-06-26T01:33:44.029Z (4 months ago)
Topics: android, architecture, coroutines, dagger
Language: Kotlin
Homepage:
Size: 4.69 MB
Stars: 154
Watchers: 5
Forks: 18
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

Awesome-Android-Open-Source-Projects - Space-app
awesome-list - ValterKasper/space-app - An Android app which shows timeline of upcoming rocket launches and showcases architecture of real application. (Kotlin)
awesome-android-kotlin-apps - space-app

README

# Planet escape: Rocket launches schedule (Work in progress 🚧👷🏗️‍️)

An android app that shows timeline of upcoming rocket launches. Showcases architecture of a real android application and usage of some libraries. Application loads data about rocket launches from the server and stores them to the database for off-line usage.

### Screenshots

| ![Timeline](./screenshots/timeline_light.png) | ![Filter](./screenshots/filter_light.png) | ![Launch detail](./screenshots/detail_light_a.png) |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| ![Timeline](./screenshots/timeline_dark.png) | ![Launch detail](./screenshots/detail_dark_a.png) | ![Launch detail](./screenshots/detail_dark_c.png) |

### Goals

- Modularize the application into modules `App` and `Domain`. `Domain` module has no android dependencies.
- Focus on testability with unit tests and UI tests. For UI tests is used the Espresso library with the [Robot pattern](https://academy.realm.io/posts/kau-jake-wharton-testing-robots/) which allows to create clear and understandable tests.
- Use kotlin coroutines for asynchronous jobs.

### Libraries Used

- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Store UI-related data that isn't destroyed on app rotations.
- [Room](https://developer.android.com/topic/libraries/architecture/room) - Store launch data received from the server in SQLite database.
- [Data Binding](https://developer.android.com/topic/libraries/data-binding/) - Declaratively bind observable data to UI elements.
- [Lifecycles](https://developer.android.com/topic/libraries/architecture/lifecycle) - Handle events from ViewModel to Fragments/Activity.
- [WorkManager](https://developer.android.com/topic/libraries/architecture/workmanager) - Used for periodic data fetching from server and for showing Android notification of upcoming launch.
- [Navigation](https://developer.android.com/topic/libraries/architecture/navigation/) - Handle everything needed for navigation between fragments and creation of deep links.
- [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) For managing asynchronous calls with simplified code and reducing needs for callbacks. For event based code are used `Flow`-s and `Channel`-s.
- Dependency injection
- [Dagger 2](https://github.com/google/dagger) Creates dependency graph for most object in the application.
- [Assited-Inject](https://github.com/square/AssistedInject) Easier creation of objects that combine parameterization and dependencies. Mainly used with ViewModels.

- [Material components](https://github.com/material-components/material-components-android) Application uses material theme for easier styling of UI components and for dark theme.

### Getting started

- App can work without the server. When app is build with parameter `use_fake_reponse_api=true` in the `gradle.properiets`, a response is generated from static JSON file in the assets.
- Otherwise, if server is used, number of requests per minute is limited.

#### Gradle tasks

- run UI tests on connected device:
`./gradlew connectedDebugAndroidTest`

- run unit tests:
`./gradlew testDebugUnitTest`

- assemble apk:
`./gradlew assembleDebug`

#### Environment variables (optional)

- `SPACE_APP_KEYSTORE_PASSWORD`

- `SPACE_APP_KEY_PASSWORD`

- `SPACE_APP_KEYSTORE_PATH`

- `SPACE_APP_API_KEY` - key will be used for communication with server

### License

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.
```