/LANshark

AR History Tour

Primary LanguageJavaScript

AR History Tour

Use augmented reality to discover facts about your city.

Table of Contents

  1. How it works
  2. On Location
  3. Database
  4. Tech Stack
  5. Development
    1. System Requirements
    2. Installation
  6. Running Tests
  7. Deployment
  8. Authors
  9. Acknowledgments

How It Works

A fun way to explore the city around you! With an ARkit or ARcore enabled smartphone, go on an augmented reality tour of your local points of interest. With a minimal interface, the focus stays on the area around you, while a click of a button will bring 3 dimensional text information into view, rooted to the area around you. Easily switch to a map view, and get a view of what else is around you that you may want to explore. Sign up, save your favorite places, and see those saved locations on a favorites map.

On Location

Database

database

Tech Stack

final-tech-tack

Development

Setting up a development environment requires global installations of node

System Requirements

  • Node 8
  • ARKit enabled Smartphone
  • ViroMedia App
  • SQL database

Installation

$ git clone https://github.com/LANsharkCryptoAnalytics/LANshark.git
$ cd LANshark/
$ yarn install
$ yarn start // this starts the client server
$ yarn server // this starts the node server (have both client and node server running simutaneously)
On your iPhone Download Viro Media from App store.
Once Viro Media has finished downloading open app
Click the menu button in the top left corner
Click "Enter TestBed"
Enter your machine's local IP address into Viro Media's Test Bed
Click "Go" button

Running Tests

$ yarn test

Deployment

It will require two independent servers to deploy this application,
one for the client/front-end and one for the back end.
 * Front end: clone the repo onto your server run "yarn install".
   Create an .env file and place the environmental variables into it.
    Run the server with the "yarn start" script
 * Back end server: Configure a server with Node.js 10.0, clone the project
  repo into it and run "yarn  install". Create a .env file with api-keys and
  environemental variables in the root file of the server
 * This application requires the Viro Media test bed app, which may be downloaded
  from the Apple App store for free. After it has been installed and loaded, enter the address of the front-end server to connect the app.

Authors

  • Alec Gilchrist
  • Josef Butts
  • Senai Ayalew
  • Joshua Blankenship

Acknowledgments

Big thanks to The Wikimedia Foundation, ViroReact, and Opspark