Skip to content

eraxillan/anilistapp

Repository files navigation

Unofficial Anilist client for Android

Anilistapp is an unofficial Android client for AniList, a place where you can track and discover Anime.

It's just a pet project made for author educational purposes!

For fully featured app, check AL chan

An app illustrating Android development best practices with Android Jetpack.

Anilistapp is still under development. Note that some changes (such as database schema modifications) are not backwards compatible and may cause the app to crash. In this case, please uninstall and re-install the app.

About Jetpack

Android Jetpack is a set of components, tools and guidance to make great Android apps. They bring together the existing Support Library and Architecture Components and arrange them into four categories:

Android Jetpack

Anilistapp demonstrates utilizing these components to create a simple Anilist client app.

Getting Started

This project uses the Gradle build system. To build this project, use the gradlew build command or use "Import Project" in Android Studio.

There are two Gradle tasks for testing the project:

  • connectedAndroidTest - for running Espresso on a connected device
  • test - for running unit tests

For more resources on learning Android development, visit the Developer Guides at developer.android.com.

Screenshots

Navigation panel List of media Media filter/sort options Plant details Favorite media list

Libraries Used

  • Foundation - Components for core system capabilities, Kotlin extensions and support for multidex and automated testing.
    • AppCompat - Degrade gracefully on older versions of Android.
    • Android KTX - Write more concise, idiomatic Kotlin code.
    • Test - An Android testing framework for unit and runtime UI tests.
  • Architecture - 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.
    • Data Binding - Declaratively bind observable data to UI elements.
    • Lifecycles - Create a UI that automatically responds to lifecycle events.
    • LiveData - Build data objects that notify views when the underlying database changes.
    • Navigation - Handle everything needed for in-app navigation.
    • Room - Access your app's SQLite database with in-app objects and compile-time checks.
    • ViewModel - Store UI-related data that isn't destroyed on app rotations. Easily schedule asynchronous tasks for optimal execution.
    • WorkManager - Manage your Android background jobs.
  • UI - Details on why and how to use UI Components in your apps - together or separate
  • Third party and miscellaneous libraries

Upcoming features

Updates will include incorporating additional Jetpack components and updating existing components as the component libraries evolve.

Interested in seeing a particular feature of the Android Framework or Jetpack implemented in this app? Please open a new issue.

Android Studio IDE setup

For development, the latest version of Android Studio is required. The latest version can be downloaded from here.

Anilistapp uses ktlint to enforce Kotlin coding styles. Here's how to configure it for use with Android Studio (instructions adapted from the ktlint README):

Non-Goals

The focus of this pet project is on Android Jetpack and the Android framework usage demonstration. Thus, there are no immediate plans to implement features outside of this scope.

Support

If you've found an error in this sample, please file an issue: https://github.com/eraxillan/anilistapp/issues

Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub.