/iihs-api-example-app

Mobile android app that will display data from the IIHS Ratings API website at https://api.iihs.org in an intuitive and consumer friendly layout

Primary LanguageC#OtherNOASSERTION

Overview

Build Status license 1.1.0

This repository contains code for a mobile android app that will display data from the IIHS Ratings API website at https://api.iihs.org in an intuitive and consumer friendly layout.

Get it on Google Play

Installation

After cloning this repository, you'll need to do a few extra things to prepare your dev workstation:

  • Download the Android Device Emulator
    • To run the app you will need either an android Device or an emulator. The official android device emulator for Visual Studio is located here.
  • Installing Xamarin
    • You will also need to modify Visual Studio to include the 'Mobile development with .NET' workload.
    • You can do this by running the 'Visual Studio Installer' and selecting 'Modify'. Scroll down to the 'Mobile & Gaming' category and select 'Mobile development with .NET'. Press 'Modify' to install the workload.

Running the app

  • This app needs an IIHS API key to use!
    • This can be obtained by registering for an account here
    • Create an api-key.txt with your key being the only content in the file
    • In Visual Studio add this file to the root of the IIHSApiApp project. In the properties of the api-key.txt file set it's content type to Embedded Resource

To run the app on a/an:

  • Emulator
    • Open 'Visual Studio Emulator for Android' and launch the device you wish to deploy to.
    • In Visual Studio select the emulated device in the debug selection box and press 'Start Debugging' (F5)
    • If this does not work you can Right Click on the solution and select 'Deploy'
  • Physical Device
    • On the device go into 'Settings' > 'About device'
    • Unlock the Developer options by tapping 'Build number' 7 times.
    • Go to 'Settings' > 'Developer options' and select 'USB debugging' to be 'On'
    • In Visual Studio select the physical device in the debug selection box and press 'Start Debugging' (F5)
    • If this does not work you can Right Click on the solution and select 'Deploy'

License

Apache 2.0