Skip to content
No description, website, or topics provided.
JavaScript HTML Objective-C Python Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
business
client
screenshots
server
README.md

README.md

ScannAR

no-text

Table of Contents

  1. Team
  2. Usage
  3. Requirements
  4. Development
  5. Contributing
  6. Screenshots

Team

  • Product Owner: Jade
  • Scrum Master: Abel
  • Development Team Members: Avery

Usage

ScannAR Business:

  • A mobile application for iOS and Android.
  • Businesses create an account.
  • Products can be added to inventory and viewed by customers in AR.
  • Product updates are reflected on customer application in real time.

ScannAR Customer:

  • A mobile application for iOS and Android.
  • Customers create an account.
  • Provides ability to view business product information through augmented reality by pointing camera at products.
  • Products shown within AR can be pressed for more information, and can be saved for later viewing.
  • Saved products may be viewed upon login and removed from saved list.

Requirements

ScannAR Business:

  • Any iOS or android device

ScannAR Customer:

  • iPhone 6s or newer for viewing products in Augmented Reality

Development

Prerequisites

  • Xcode for running iPhone simulator
  • Android Studio for running Andriod simulator
  • Viro Media application (for customer application only)
  • Expo Client application
  • Firebase project account
  • PostgreSQL
  • Node.js

Roadmap

Fork & Clone Repo from:

https://github.com/Assert-Reconceptualization/ScannAr

Getting Started

ScannAR API

  • cd server
  • cd feathers
  • npm install
  • npm start

Configuring database

  • Enter Postgresql repl psql
  • Create scannar database CREATE DATABASE scannar
  • Update Sequelize connection url, user, and password in server/feathers/src/sequelize.js

ScannAR for Business

  • cd business
  • npm install
  • Deploy cloud function on google. Download project configuration json file from firebase and include in functions directory
    • run firebase deploy from functions directory
  • To start application on simulator or through expo run npm start from root directory

ScannAR for Customers

  • cd client
  • npm install
  • Download Viro Media Application via iOS app store
  • npm start
  • Use ngrok link in Viro Media testbed to open application

Contributing

  1. Fork the project and clone it to your local machine.
  2. Create a branch with your GitHub username as a prefix, for example: git checkout -b USERNAME/new-feature or git checkout -b USERNAME/fixing-bug where USERNAME should be replaced by your username.
  3. Code and commit your changes.
  4. Push to the branch: git push origin USERNAME/new-feature
  5. Create a pull request for your branch

Screenshots

Business

business-login inventory-empty inventory login

Customer

customer-login saved-items AR login
You can’t perform that action at this time.