{"id":32480236,"url":"https://github.com/boehm-e/webxr_threejs_ar","last_synced_at":"2026-04-02T01:16:32.831Z","repository":{"id":49719374,"uuid":"245200507","full_name":"boehm-e/webxr_threejs_AR","owner":"boehm-e","description":"Starter kit  webxr \u0026 Three.JS for Augmented reality","archived":false,"fork":false,"pushed_at":"2021-09-09T15:30:13.000Z","size":9685,"stargazers_count":24,"open_issues_count":2,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-27T01:56:50.202Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boehm-e.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-05T15:33:07.000Z","updated_at":"2025-08-22T03:53:30.000Z","dependencies_parsed_at":"2022-09-06T06:13:20.442Z","dependency_job_id":null,"html_url":"https://github.com/boehm-e/webxr_threejs_AR","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/boehm-e/webxr_threejs_AR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boehm-e%2Fwebxr_threejs_AR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boehm-e%2Fwebxr_threejs_AR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boehm-e%2Fwebxr_threejs_AR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boehm-e%2Fwebxr_threejs_AR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boehm-e","download_url":"https://codeload.github.com/boehm-e/webxr_threejs_AR/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boehm-e%2Fwebxr_threejs_AR/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31293748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T01:05:07.454Z","status":"ssl_error","status_checked_at":"2026-04-02T00:56:46.496Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-27T01:56:49.187Z","updated_at":"2026-04-02T01:16:32.807Z","avatar_url":"https://github.com/boehm-e.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# webxr three.js AR\nThis project aims to help you use Three.js with WebXr to create an Augmented Reality APP easily\n\n## Context\nSome time ago, I read about WebArOnArCore, and I thought it could be cool to try to add some augmented reality to my website. But the main issue was that nobody would want to install a custom web browser just to see it.\nSo I waited, and I waited, and it arrived ! WebXr now supports Augmented Reality in Google Chrome mobile.\n  I think it could be cool to have more people developing AR components on their websites, so I decided to create a simple starter kit, with some abstraction over the still quite complex WebXr API to allow more people to develop their experiences.\n\n## Installation\nFirst Generate a self-signed certificate in order to be able to test the AR app, because AR session require to be served by https. You will see a warning message because the certificate is self-signed, ignore it.\n```sh\nopenssl req -newkey rsa:4096 \\\n            -x509 \\\n            -sha256 \\\n            -days 3650 \\\n            -nodes \\\n            -out server.cert \\\n            -keyout server.key\n\n```\n\nInstall the dependencies\n```javascript\nnpm install\n```\n\nRun the project with webpack-dev-server, it will reload the project as soon as a change is detected so you can debug in real-time.\n```javascript\nwebpack-dev-server --config webpack.config.js --port 3000 --hot --host 0.0.0.0\n```\n\n## Features\nI provide a arHelper class, that will do a lot of abstraction for you to be able to setup new AR project easily. This class provides :\n\n```javascript\n- ArHelper(context)\n// The constructor is called with the context of the class that instantiate.\n// It needs to implement three methods :\n    - onFrame(time, frame, pose){}\n    // this method will be called before each render of the Three scene, the main logic of your app should be here.\n    - onTouchStart(event){}\n    // Screen pressed event\n    - onTouchEnd(event){}\n    // Screen released event\n\n- ArHelper().getThreeScene()\n// get the Three.JS scene\n\n- ArHelper().isDown()\n// check if the screen is currently pressed\n\n- async ArHelper().getHits(frame)\n// request hit test for the frame: returns  all the position matrix (THREE.Matrix4) of intersected planar surfaces (ground, walls or any other planar surfaces).\n\n- ArHelper().getProjectionMatrix(frame)\n// returns the projectionMatrix\n```\n\n## Example\nOut of the box the project comes with an example : MyArScene.js\n- Click on the Start AR button\n- The AR session starts\n- Move your phone over the ground in order to detect planar surface.\n- Click on the screen\n- A green box appears on the ground\n\n\u003cimg src=\"demo/demo.jpg\" width=\"400\"/\u003e\n\n## Online Demo:\nIf you want to see what I have done starting from this project: \u003cbr/\u003e\nGo to my personal website, and click the top banner to start the AR experience (yes it is in french :/)\n[https://boehm-e.github.io/](https://boehm-e.github.io/#/ar) \u003cbr/\u003e\u003cbr/\u003e\n\n\u003cimg src=\"demo/demo_website.gif\" width=\"400\"/\u003e\n\n\n\n## Credit\nDon't hesitate to contact me if you have any questions at : erwan.boehm@gmail.com\n[Erwan BOEHM](https://boehm-e.github.io/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboehm-e%2Fwebxr_threejs_ar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboehm-e%2Fwebxr_threejs_ar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboehm-e%2Fwebxr_threejs_ar/lists"}