yannklein/ar_graffiti_rails

AR graffiti

A Web AR app that let multiple users across the world graf the same virtual wall.

Demo . Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Demo
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Acknowledgments

About The Project

The project is a Rails app using ActionCable (websocket) to unabel muliptle user to interact in real-time. On the frontend side, it is powered with ThreeJS and ARJS to produce Augmented Reality grafs on the top of a QR code. The QR code is used as a link to the web app as well as an AR marker.

Technical highlights of the project:

1. Rails fullstack application
2. ActionCable powered websocket for live user interactions
3. ThreeJS and ARJS on the frontend side

(back to top)

Built With

• 
• 

(back to top)

Demo

ar-graffiti.webm

Prerequisites

This project needs a environment with ruby and bundler installed.

Installation

1. Install the backend and frontend packages:

   bundle install
   yarn install

2. Migrate the db, populate it and run the server:

   rails db:migrate db:seed
   rails s

(back to top)

Usage

See the video for an overview of the app content: Demo.

(back to top)

License

Distributed under the MIT License.

(back to top)

Acknowledgments

• Img Shields
• GitHub Pages

(back to top)