https://github.com/krsbx/react-ar-next

The Next React Web AR
https://github.com/krsbx/react-ar-next

Last synced: 11 days ago
JSON representation

The Next React Web AR

• Host: GitHub
• URL: https://github.com/krsbx/react-ar-next
• Owner: krsbx
• License: mit
• Created: 2021-10-24T13:50:01.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-19T04:28:49.000Z (about 3 years ago)
• Last Synced: 2024-12-13T03:55:37.673Z (about 1 month ago)
• Language: TypeScript
• Size: 1020 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Getting Started with React AR Next

This project was base on [React Web AR](https://github.com/nitin42/React-Web-AR).

## Available Component

In your React Component you could use:

### `ARProvider`

This component need to be on the top level before you use AFrameRenderer or any other Component.

### `AFrameRenderer`

This component will generate a new scene for the Augmented Reality

### `Box`

This component is a primitive box element in [AFrame](https://aframe.io/docs/1.2.0/primitives/a-box.html)

### `Entity`

This component is an entity element in [AFrame](https://aframe.io/docs/1.2.0/core/entity.html)

### `Marker`

This component is a marker object in [AR Js](https://ar-js-org.github.io/AR.js-Docs/marker-based/)

### `Text`

This component is a primitive text element in [AFrame](https://aframe.io/docs/1.2.0/primitives/a-text.html)

### `Example`

This component is an example of the [AR Js](https://ar-js-org.github.io/AR.js-Docs/)

## Installation

You can read more about the installation in the installation [here](/docs/install.md)

## Usage and Implementations

You can find the detailed documentations of the usage [here](/docs/usage.md)

## Changelog

You can find changelogs of the project [here](docs/changelog.md)

## To Do

You can find the upcoming one for this project in [here](docs/todo.md)