Skip to content
 
 

Repository files navigation

Lambertville XR

Website for Lambertville XR walking tour. The website is hosted on https://rutgersgrid.github.io/lambertvillexr.

Developing

Prerequisites

  • Make sure you have NodeJS installed.

  • Clone this repository

  • Run

    npm i

Hosting a local server

Run

npm run dev

Hosting a local server live

If you need to test the website from different devices, it's best to host the server live through a proxy. This repo has scripts to host from ngrok.

Using ngrok

Make sure you have ngrok installed and have registered an ngrok account and setup your ngrok token.

Run

npm run dev

In a separate terminal, run

npm run ngrok

NOTE:

We have a separate command for ngrok because it doesn't display any output when its used with the "concurrently" npm command.

Building the website

Run

npm run build

The static website should be built inside of the .output/public folder.

Settings

The settings for building the website can be configured by environment variables.

  • HIDE_DEMOS
    • If set to true, then the demos will not be built. This should be enabled for production builds.
  • META_URL
    • If set, then all social media previews will link to this URL. This should be set for production builds.
  • STORYMAP_URL
    • If set, then the story map url on the site will link to this URL. This should be set for production builds.

Site URLs

Navigating to a site with ?ar=true after its url will automatically enter AR mode when loaded. When making actual site QR codes, you should include this query text to the end of the site urls to ensure users are sent to AR mode immediately after they open the site from the QR code.

Ex.

https://rutgersgrid.github.io/lambertvillexr/sites/site-1/?ar=true
https://rutgersgrid.github.io/lambertvillexr/sites/site-2/?ar=true
https://rutgersgrid.github.io/lambertvillexr/sites/site-3/?ar=true
...

Credits

About

Lambertville XR Walking Tour: Flowing Together

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages