Skip to content

Latest commit

 

History

History
79 lines (64 loc) · 4.17 KB

README.md

File metadata and controls

79 lines (64 loc) · 4.17 KB
Raw

SEDaily-Android

logo

A player for the Software Engineering Daily Podcast

Getting Started

The app has 2 build types: debug and release with minor differences between both builds. Stetho for example is only enabled for debug builds. And Timber to log warnings and errors as Crashlytics non-fatal crashes in release builds.

We also use different app icons for debug and release builds and you can keep both builds on your device and run them side by side.

The app is 100% Kotlin and we think it is better to keep it this way.

We use Koin which is a lightweight dependency injection framework to manage all dependencies. And Kotlin Coroutines for asynchronous work. We also use Kotlin Coroutines with Room and Retrofit.

Cloning the Project

$ git clone https://github.com/SoftwareEngineeringDaily/SEDaily-Android.git
$ cd SEDaily-Android

And then compile the project with Gradle using

./gradlew build

Screenshots

App screenshots

Libraries Used

  • Foundation - Components for core system capabilities, and Kotlin extensions.
    • AppCompat - Degrade gracefully on older versions of Android.
    • Android KTX - Write more concise, idiomatic Kotlin code and helper functions for easy integration with coroutines.
    • exoplayer to manage the media playback.
  • Architecture - A collection of libraries that help design robust, testable, and maintainable apps.
    • Lifecycles - Create a UI that automatically responds to lifecycle events.
    • LiveData - Build data objects that notify views when the underlying data changes.
    • Navigation - Handle everything needed for in-app navigation.
    • Room - Access app's SQLite database with in-app objects and compile-time checks.
    • ViewModel - Store UI-related data that isn't destroyed on app rotations.
  • Third party
    • Glide for image loading.
    • Epoxy for building complex screens in a RecyclerView.
    • Koin a lightweight dependency injection framework to manage all dependencies.
    • Retrofit a type-safe HTTP client for Android and Java.
    • Timber to log warnings and errors as Crashlytics non-fatal crashes in release builds.
    • Kotlin Coroutines for managing background threads with simplified code and reducing needs for callbacks.

Upcoming features

Interested in seeing a particular feature implemented in this app? Please open a new issue with a feature proposal.

Contributing

Checkout CONTRIBUTING.md for details.