Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 4.14 KB

README.md

File metadata and controls

79 lines (57 loc) · 4.14 KB
Raw

Android CI Contributors License Issues Pull Requests

AR Reshare App

An augmented-reality enabled application allowing people to share the goods and gifts they no longer need or want.

The app allows a contributor to list an item they would like to share for free along with their postcode. A consumer can either search for an item or they can find items in their local area via an Augmented Reality interface. The consumer can then get in touch with the contributor and arrange a pickup. This project was developed by a team of University of Bristol students in collaboration with Durham University.

Alt text


AR Reshare Clip 1 AR Reshare Clip 2 AR Reshare Clip 3


Table of Contents

  1. About
  2. Getting Started
  3. Architecture
  4. Backend Deployment
  5. License
  6. Contact

Getting Started

Prerequisites

  • Android Studio (available to download here), and
  • Android Device with API Level 27 (8.1 Oreo) or above, or
  • Computer capable of running the Android Emulator

Note: To use the AR functionality the Android Device must be AR Compatible. Here is the list of currently supported devices.

Setup and Build

In Android Studio

  1. Go to File > Open... and choose the location of the project.
  2. Select Trust project and wait for Gradle sync to be finished.
  3. In the tool bar, select Build > Make Project.
  4. In the tool bar, select Run > Edit Configurations. Ensure that the module is selected to be AR-Reshare.app and that the Launch Activity is specified to Default Activity.

Running the Application

To run the application on an emulated Android Device:

  1. In Android Studio, select Run > Select Device... > AVD Manager.
  2. Select Create Virtual Device and choose one of the devices available.
  3. Select Android System with API Level 27 (8.1 Oreo) or above.
  4. Once the installation is complete, select your new emulated device and go to Run > Run 'app'.

To run the application on a physical Android Device:

  1. Go to Settings > About Phone > Build Number and repeatedly press Build Number to enable the Developer Options.
  2. Connect the Android device to your computer.
  3. Choose to Trust the Computer and give all necessary permissions.
  4. In Android Studio, select Run > Select Device... and choose your device.
  5. Now select Run > Run 'app' to install and run the application directly on your device.

Architecture

The architecture for AR Reshare's model, user interface and backend integration can be found here.

Backend Deployment

The backend for this application has been developed by the team from Durham University. You may find the API docs here and the repository containing the backend source code here.

License

This project has been licensed under the MIT License

Contact

For contact and queries about contributing to the project, please email grp-ar-reshare@groups.bristol.ac.uk.