Skip to content

r3x-tech/ar-tester

 
 

Repository files navigation

React AR Web3 Starter

🌎 Live App Here

Getting started

To make it easy for you to get started with 8thWall AR for web and Web3 here's a repo to get you up and running with a self-hosted version of 8thWall. It includes some pre-configured web3 libraries and it is built using Next.js so you can deploy easily to Vercel!

This example assumes you have access to an 8thWall workspace through theLightship VPS World Tour, an 8thWall free trial, or paid account. You will also need a github account which will make deploying to vercel easy and most likely free.

Installation

  • Clone this repository

    git clone --- INSERT PUBLIC REPO URL HERE ---
    cd react-ar-web3-starter
    yarn
    
  • Install mkcert globally, please click mkcert link to see docs for Linux and Windows.

    On macOS, use Homebrew

    brew install mkcert
    brew install nss # if you use Firefox
    

    or MacPorts.

    sudo port selfupdate
    sudo port install mkcert
    sudo port install nss # if you use Firefox
    
  • Generate a certificate with key by running the following command in the src directory of this repo.

    mkcert localhost
    
  • Start server

    node server.js
    

    What's going on? Learn more here, medium article overview of mkcert installation.

  • setup 8thWall account

  • setup wallet connect or web3Auth (formerly Torus)

Deployment

  • When you're ready to deploy head over to Vercel and sign-in/sign-up with the account where your repository is; github, gitlab, etc.

vercel dashboard screenshot

  • Once you're logged in you're going to click the 'Add New' and select project from the drop down.

add new button

  • Import the repo where your code lives

import repository

  • Make sure the project name and everything is to your liking then click deploy!

deploy project

  • Make sure the project name and everything is to your liking then click deploy!

copy deployed domain

  • Go to your 8thWall workspace and add the domain you just copied to the list of authorized domains

head to 8thwall workspace

  • Open the "Setup this project for self-hosting or local development" section and paste the domain name you copied WITHOUT "https://" into the input field. Click the "+" button and it needs to appear in the list below

add hosting

  • IMPORTANT! Make sure to double check the app key in your project: demoARexperience.html approx at line 16 matches the appkey in your 8thWall workspace!

The key included in this repo will work for localhost, but WILL NOT work on your deployed app. You will need your own key or check with someone from the VPS World Tour Staff to help get your deployed domain added to the shared workspace.

demo at html file

Make sure that you select the settings page on the left and open the "My App Key" section under Self-Hosting

settings page

  • add .env files to Vercel

settings page

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 50.8%
  • TypeScript 36.6%
  • HTML 12.4%
  • CSS 0.2%