/kibUtil

Practicing the use of Jetpack Libraries.

Primary LanguageKotlin

Android Fun

Android Fun is a sample Android project that was created to help developers practice various common Android concepts. This project is built using Kotlin, and includes several popular Android libraries and Jetpack components.

Dependencies

The following is a list of major dependencies used in this project, along with links to their documentations:

  • Jetpack Compose - Android's modern UI toolkit for building native UIs.
  • Room - An abstraction layer over SQLite used for data persistence.
  • Kotlin Coroutines - A library for writing asynchronous, non-blocking code in a sequential style.
  • Koin - A lightweight dependency injection framework for Kotlin.
  • Retrofit - A type-safe HTTP client for Android and Java.

Running the Project

To run the project, follow these steps:

  1. Clone or download the repository from GitHub.
  2. Open the project in Android Studio.
  3. Build and run the project on an emulator or physical device.

Testing the Project

The project includes unit tests and instrumentation tests that can be run using Android Studio or the command line. To run the tests, follow these steps:

  1. Open the project in Android Studio.
  2. To run unit tests, open the test folder in the Project pane, right-click on a test class, and select "Run tests".
  3. To run instrumentation tests, open the androidTest folder in the Project pane, right-click on a test class, and select "Run tests".

Alternatively, you can run the tests from the command line using the following commands:

  • To run unit tests: ./gradlew test
  • To run instrumentation tests: ./gradlew connectedAndroidTest

Linting the Project

The project includes a linting configuration that checks for common coding issues and best practices. To run the linter, follow these steps:

  1. Open the project in Android Studio.
  2. Click on "Run" in the menu bar, and select "Run Lint".
  3. The lint results will be displayed in the "Lint" pane at the bottom of the screen.

Alternatively, you can run the linter from the command line using the following command:

  • ./gradlew lint

This will generate an HTML report that can be viewed in a browser.

Conclusion

Android Fun is a great project for developers who want to practice their Android skills and learn about popular Android libraries and Jetpack components. With its clear documentation and easy-to-follow setup instructions, developers can easily get started with the project and start learning new Android concepts.