Skip to content

Kotlin app that displays public repositories of any user.

License

Notifications You must be signed in to change notification settings

davidevol/Repository-Searcher

Repository files navigation

Repository-Searcher - GitHub Repositories Viewer

Overview

Repository-Searcher is a Kotlin-based application developed as part of a comprehensive bootcamp. The primary purpose of the app is to provide a user-friendly interface for exploring public repositories on GitHub. Utilizing the Model-View-ViewModel (MVVM) architecture, Repository-Searcher ensures a clean and modular codebase, promoting maintainability and scalability.

Features

  • GitHub Integration: Repository-Searcher seamlessly integrates with the official GitHub API to fetch and display public repositories of any user.

  • MVVM Architecture: The app follows the MVVM architectural pattern, separating concerns into distinct layers - Model, View, and ViewModel. This enhances code organization, testability, and overall project structure.

  • Anti-Abuse Measures: Repository-Searcher incorporates anti-abuse mechanisms to adhere to GitHub's usage policies. These measures ensure responsible API usage and prevent any potential abuse.

Installation

  1. Clone the repository to your local machine.

    git clone https://github.com/davidevol/Repository-Searcher.git
  2. Open the project using your preferred Kotlin development environment.

  3. Build and run the application on your emulator or physical device.

Usage

  1. Launch the Repository-Searcher app on your mobile device or emulator.

  2. Enter the GitHub username for which you want to explore public repositories.

  3. Browse through the displayed repositories, gaining insights into project details.

Dependencies

  • Kotlin
  • Android Jetpack Components (ViewModel, LiveData, etc.)
  • Retrofit for API communication
  • GitHub API

Contributing

Contributions to Repository-Searcher are welcome. If you have suggestions, improvements, or bug fixes, feel free to create a pull request.

License

This project is licensed under the MIT License.

Acknowledgments

Special thanks to the developers and mentors involved in the bootcamp, whose guidance and support contributed to the successful completion of this project.