# React WebXR

## Status
[![Build status](https://ci.appveyor.com/api/projects/status/9uxqva5vglckj6r4?svg=true)](https://ci.appveyor.com/project/ChrisDobby/react-webxr)
[![Storybook](https://cdn.jsdelivr.net/gh/storybooks/brand@master/badge/badge-storybook.svg)](https://react-webxr.chrisdobby.dev/)
[![npm version](https://badge.fury.io/js/react-webxr.svg)](https://badge.fury.io/js/react-webxr)

## Overview

React WebXR is an attempt at creating [React](https://reactjs.org/) components implementing some of the [WebXR Device API](https://www.w3.org/TR/webxr/). The intention is to start with some of the augmented reality features - firstly the Hit Test API.

## Components

A list of components and usage can be found in the [![storybook](https://cdn.jsdelivr.net/gh/storybooks/brand@master/badge/badge-storybook.svg)](https://react-webxr.chrisdobby.dev/)

## Browser Support

Currently the augmented reality features in WebXR are only supported in the Chrome 81 for Android - currently in [beta](https://www.google.com/chrome/beta/)

[caniuse WebXR](https://caniuse.com/#feat=webxr)

## Prerequisites

[nodejs](https://nodejs.org)

[yarn](https://yarnpkg.com/)

## Getting Started

Once you have cloned the repository run `yarn` to install the package dependencies.
Then run `yarn storybook` to run the storybook application on http://localhost:3000