https://github.com/andremion/hostel
https://github.com/andremion/hostel
android android-architecture-components dagger2 dagger2-android data-binding hostel kotlin reactive-extensions room rxandroid rxjava2 view-model
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/andremion/hostel
- Owner: andremion
- License: apache-2.0
- Created: 2018-04-08T19:11:06.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-11T12:10:45.000Z (about 7 years ago)
- Last Synced: 2024-10-29T18:12:50.614Z (7 months ago)
- Topics: android, android-architecture-components, dagger2, dagger2-android, data-binding, hostel, kotlin, reactive-extensions, room, rxandroid, rxjava2, view-model
- Language: Kotlin
- Size: 243 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hostel
[](http://www.apache.org/licenses/LICENSE-2.0)
[](https://circleci.com/gh/andremion/Hostel)
[](https://codecov.io/gh/andremion/Hostel)
## Structure
This project has two Android modules:
### [app]
- Contains presentation, Android platform and [dependency injection] classes.
The ViewModels are used to consume reactive streams from [repository] and update observable fields for data binding.
### [data]
- Contains entities, repository, data sources (remote and local) classes.
Since the database is empty, the repository will request the data from remote data source and then save into local data source.
The repository exposes only reactive [entities].
The local data source saves data into database.
The [local] data source has its own models used internally as well as the [remote] data source has its own.
The local data source uses database that saves data in [disk] while in testings is used a database that saves in [test].
## Libraries and tools used
### Android
* [Android Support Library](https://developer.android.com/topic/libraries/support-library/index.html)
Provides additional convenience classes and features not available in the standard Framework API for easier development and support across more devices.
* [Data Binding](https://developer.android.com/topic/libraries/data-binding)
Write declarative layouts and minimize the glue code necessary to bind application logic and layouts.
### Architecture and Design
* [Android Architecture Components](https://developer.android.com/topic/libraries/architecture/index.html)
A collection of libraries that help you design robust, testable, and maintainable apps.
Start with classes for managing your UI component lifecycle and handling data persistence.
* [Dagger](https://google.github.io/dagger)
A fully static, compile-time dependency injection framework for both Java and Android.
### Reactive
* [RX Java](https://github.com/ReactiveX/RxJava)
A library for composing asynchronous and event-based programs using observable sequences for the Java VM.
* [RX Android](https://github.com/ReactiveX/RxAndroid)
RxJava bindings for Android.
### View and Image
* [ConstraintLayout](https://developer.android.com/training/constraint-layout/index.html)
Allows you to create large and complex layouts with a flat view hierarchy (no nested view groups).
* [RecyclerView](http://developer.android.com/reference/android/support/v7/widget/RecyclerView.html)
A flexible view for providing a limited window into a large data set.
* [Glide](https://github.com/bumptech/glide)
An image loading and caching library for Android focused on smooth scrolling.
### Data Request
* [Retrofit](http://square.github.io/retrofit/)
A type-safe HTTP client for Android and Java.
* [OkHttp](http://square.github.io/okhttp/)
An HTTP & HTTP/2 client for Android and Java applications.
* [Gson](https://github.com/google/gson)
A Java serialization/deserialization library to convert Java Objects into JSON and back.
### Persistence
* [Room](https://developer.android.com/topic/libraries/architecture/room.html)
The Room persistence library provides an abstraction layer over SQLite to allow fluent database access while harnessing the full power of SQLite.
### Testing
* [Mockito](https://github.com/mockito/mockito)
Tasty mocking framework for unit tests in Java.
* [Espresso](https://developer.android.com/training/testing/espresso/index.html)
Write concise, beautiful, and reliable Android UI tests.
* [MockWebServer](https://github.com/square/okhttp/tree/master/mockwebserver)
A scriptable web server for testing HTTP clients.
## License
Copyright 2018 André Mion
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.
[app]: app "App module"
[dependency injection]: app/src/main/java/com/andremion/hostel/app/internal/injection "Dependency injection classes"
[data]: data "Data module"
[entities]: data/src/main/java/com/andremion/hostel/data/entity "Entities"
[repository]: data/src/main/java/com/andremion/hostel/data/repository "Repository"
[local]: data/src/main/java/com/andremion/hostel/data/local "Local data source"
[disk]: data/src/main/java/com/andremion/hostel/data/local/database/disk "Disk database"
[test]: data/src/main/java/com/andremion/hostel/data/local/database/test "Test database"
[remote]: data/src/main/java/com/andremion/hostel/data/remote "Remote data source"