Skip to content

Examples of WebAR fundamentals, powered by 8th Wall

Notifications You must be signed in to change notification settings

holistic-web/ar-examples

Repository files navigation

AR Examples

A collection of examples of web AR fundamentals, powered by Niantic's 8th Wall framework. The examples here are meant to be used as components in future projects.

Short Term TODO:

  • demonstrate any AR working through nuxt
  • add deployment to augmented-reality.web.app through firebase
  • add main website to navigate between examples
  • add first example
  • add another project
  • replace this document with a more relevant readme

How it Works

This project is a Nuxt application that builds into a static web app. The AR configuration is powered by 8th Wall.

8th Wall Configuration

We have an account for 8th wall, and will document where this is setup soon.

Build Setup

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

For detailed explanation on how things work, check out the documentation.

Special Directories

You can create the following extra directories, some of which have special behaviors. Only pages is required; you can delete them if you don't want to use their functionality.

assets

The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.

More information about the usage of this directory in the documentation.

components

The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.

More information about the usage of this directory in the documentation.

layouts

Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.

More information about the usage of this directory in the documentation.

pages

This directory contains your application views and routes. Nuxt will read all the *.vue files inside this directory and setup Vue Router automatically.

More information about the usage of this directory in the documentation.

plugins

The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use Vue.use(), you should create a file in plugins/ and add its path to plugins in nuxt.config.js.

More information about the usage of this directory in the documentation.

static

This directory contains your static files. Each file inside this directory is mapped to /.

Example: /static/robots.txt is mapped as /robots.txt.

More information about the usage of this directory in the documentation.

store

This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.

More information about the usage of this directory in the documentation.

About

Examples of WebAR fundamentals, powered by 8th Wall

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published