react-web-ar's Introduction

React-Web-AR

Experimental and work in progress 🚧

Documentation

You can find the detailed documentation here.

Todo

AR Renderer for threejs - This will be done when AR.js stabilizes its API. Currently, everything is jumbled up!
Component for creating portals - Using aframe primitive.
Write tests - ??
Add more examples
Cleanup

Note

This is still an experimental project and it also relies on AR.js which is also being developed actively. I'll share a roadmap soon covering every detail. I'll recommend not to use this project in production because it's still not graduated from the experimental stage and requires a lot of internal work to go from experimental to stable. But, mostly importantly you can play with this project and can try to explore the augmented reality domain. I am sure that you'll enjoy this stuff. Thanks!

react-web-ar's Issues

Image Link not working

In the usage section, the link to the demo image is leading a 404 page. super minor but i thought it was important to make it known 😄

Help

Hi!

I'm experience React developer and I'm starting working with AR. I see your project and I want to contribute. How Can I help?

Cannot read property 'ArToolkitContext' of undefined

I've tried to launch an example from the docs and got an error: Cannot read property 'ArToolkitContext' of undefined
Could you tell me what can be a reason of this behavior?

Can you help me?

I need simple markerless AR (react)
Can you help me?

NPM or yarn

This may be SUPER minor but I figured that it was worth bringing up.

I see that this relies on yarn but then in the installation it is suggested to use npm. to my knowledge, yarn can be used in place of npm to better manage packages. since the project comes with a yarn.lock file I figured that it was probably best practice to use the yarn add command as opposed to npm i.

again, i know it's super minor but since you're the creator of the project and you utilize yarn, it may be wise to suggest this to users 😄

Recommend Projects