Skip to content

Latest commit

 

History

History
111 lines (66 loc) · 3.05 KB

File metadata and controls

111 lines (66 loc) · 3.05 KB

Github-Repository

This project aims to provide the latest 'Android Github repositories' on Android Device. It shows the list of repositories and the detailed information of the repository

Tools Used to build the application are Android, Kotlin, Java and retrofit2


Table of contents

Installation

1. Clone

  • Clone this repo to your local machine using https://github.com/codegenerator-tools/Github-Repository/Github-Repository.git

2. Building the Application

  • Open Android Studio and select File->Open... or from the Android Launcher select Import project and navigate to the root directory of your project.
  • Click 'OK' to open the the project in Android Studio.
  • A Gradle sync should start, but you can force a sync and build the 'app' module as needed.

3. Running the Application

Connect an Android device to your development machine.

  • Select Run -> Run 'app' (or Debug 'app') from the menu bar
  • Select the device you wish to run the app on and click 'OK'

4. Using the Application

As the app launches, it should bring the list of Android Github repositories The list should contain the repository name and the last modified timestamp. Tapping on the repository(list-item) should bring the detailed information about the repository It requires internet connection to be available in the mobile


Project Structure

alt text

Sequence Diagram

  • Added as a quick reference to get started

alt text


Contributing

To get started...

Step 1

  • Option 1

    • 🍴 Fork this repo!
  • Option 2

    • 👯 Clone this repo to your local machine using https://github.com/harshprashar/Github-Repository.git

Step 2

  • HACK AWAY! 🔨🔨🔨

Step 3


License

License