Skip to content

Latest commit

 

History

History
131 lines (86 loc) · 3.35 KB

README.md

File metadata and controls

131 lines (86 loc) · 3.35 KB
Raw

Project logo

API app for developers

Status Github top language Github language count Repository size License Github forks

Android application for finding public APIs'

📝 Table of Contents

🧐 About

This is an application that displays a list of public api for use by developers. This app consists of 2 sections: The API list section and the API detail section.

The projects is implemented using clean architecture with the MVVM (Model View Model) pattern. The project is thus layered into 3 parts

  • Domain
  • Data
  • App

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

First before you run the application a the user is required to be having the following installed :

Android Studion
Kotlin

Installing

A step by step series of examples that tell you how to get the application running.

Clone the project into your device

# Clone this project
$ git clone https://github.com/SamoraMachel/Public-API-App

# Access
$ cd publicapi

open the app in android studio and run.

🔧 Running the tests

To run the test, in the root folder of the application use:

# run tests
$ ./gradlew test

🎈 Usage

Build the application and in your android phone or emulator and run the application.

⛏️ Built Using

  • Kotlin
  • Sliding PaneLayout
  • Retrofit
  • Material Design
  • Kotlin coroutines
  • Android Jetpack
    • View Binding
    • Live Data
    • Navigation

✍️ Authors

See also the list of contributors who participated in this project.