Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AtriTripathi authored Apr 8, 2021
1 parent 1e36980 commit 8946072
Showing 1 changed file with 71 additions and 2 deletions.
73 changes: 71 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,74 @@
# Musk
It is a modern Android app that uses SpaceX API to display all the Rockets, Launches, and Crew members. It uses Clean Architecture with Repository Pattern for robust local DB caching.
> Download the debug APK from [Releases](https://github.com/AtriTripathi/Tasks/).
## Screenshots

## Screens
<img src="./assets/rockets_gif.gif" width="30%">&ensp;<img src="./assets/crew_gif.gif" width="30%">&ensp;<img src="./assets/launches_gif.gif" width="30%">

## Architecture - MVVM
`MVVM (Model-View-ViewModel) Architecture` combines the advantages of separation of concerns provided by MVP, while maintaining testability. This results in a pattern where the model drives as many of the operations as possible, minimizing the logic in the view.

## Libraries Used

### [Jetpack Libraries](https://developer.android.com/jetpack)
Jetpack is a suite of libraries to help follow best practices, reduce boilerplate code, and write code that works consistently across Android versions and devices.

### [Architecture Components](https://developer.android.com/topic/libraries/architecture)
Android Architecture Components like `ViewModel`, `LiveData`and Lifecycle-aware components are implemented in this app for a more robust, testable and maintainable codebase.

### [Dagger-Hilt](https://dagger.dev/hilt/)
`Dagger-Hilt` is responsible for Dependency Injection throughout the app. It is used to inject dependencies like `Room` instance and `ViewModels`.

### [Coroutines](https://kotlinlang.org/docs/coroutines-overview.html)
`Coroutines` is used to execute code in an asynchronous and non-blocking way. It is heavily used in the `ViewModels` and also to make databse requests to the Room instance.

### [Room](https://developer.android.com/jetpack/androidx/releases/room)
`Room` persistence library provides an abstraction layer over SQLite to allow for more robust database access. It provides compile-time query verification, convenience annotations and less boilerplate code.

### [Navigation Components](https://developer.android.com/guide/navigation)
Navigation components is used to handle fragment transactions, and Up and Back actions correctly by default. It simplifies navigation and passing data between destinations in a type-safe way using `Safe Args`.

### [View Binding](https://developer.android.com/topic/libraries/view-binding)
View Binding is used to ensure compile-time safety for accessing the view hierarchy. It creates an instance of a binding class that contains direct references to all views that have an ID in the corresponding layout.

### [Material Components](https://material.io/develop/android/)
Material Components provide beautiful UI elements with a lots of customizations. It is used as it defines the latest standards for design by Google.

### [Retrofit](https://github.com/square/retrofit)
Retrofit with `Moshi` for JSON serialization/deserialization is used for networking in the app to make API calls to the SpaceX API.

### [OkHttp Logging Interceptor](https://square.github.io/okhttp/)
The OkHttp interceptor logs request and response information, and has been used to used to log all the body-level details related to the network calls for debugging purposes.

### [Lottie Animations](https://github.com/airbnb/lottie-android/)
Lottie is an amazing library for easy animations in Android, iOS and Web. The animations seen in this app represent some of the states of the app: Loading, Error or No Internet.

### [Glide](https://github.com/bumptech/glide)
Glide is the image library used in this app. It is fast and offers more fine-grained control over image loading.

### [Timber Logging](https://github.com/JakeWharton/timber)
`Timber` is a logger with a small, extensible API which provides utility on top of Android's normal Log class. It has been used for debugging purposes.

## Developed By

### Atri Tripathi

<img src="https://github.com/atritripathi.png" width="20%">

[atritripathi.com](https://atritripathi.com)

## License

Copyright 2021 Atri Tripathi

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.

0 comments on commit 8946072

Please sign in to comment.