Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/argonjs/argon-aframe
glue to use aframe to author argon applications
https://github.com/argonjs/argon-aframe
aframe argon augmented-reality
Last synced: 2 months ago
JSON representation
glue to use aframe to author argon applications
- Host: GitHub
- URL: https://github.com/argonjs/argon-aframe
- Owner: argonjs
- License: mit
- Created: 2016-07-25T19:36:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-25T16:00:34.000Z (about 7 years ago)
- Last Synced: 2024-06-22T19:40:31.471Z (5 months ago)
- Topics: aframe, argon, augmented-reality
- Language: JavaScript
- Homepage: https://aframe.argonjs.io
- Size: 8.52 MB
- Stars: 45
- Watchers: 11
- Forks: 18
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# argon-aframe
A collection of components, entities and systems to integrate [A-Frame](https://aframe.io) with [argon.js](http://argonjs.io/), so augmented reality content for the Argon web browser can be created with A-Frame.
## A note about using https for development
More and more, modern web browsers demand that you use https:// instead of http://. You cannot, for example, use the web location APIs, or access video via WebRTC, over http connections on many browsers. If you want to do development using https and node.js use the _devssl_ target (used by doing `npm run devssl`).
## Documentation
To see documentation of the collection of Entities and Components that link Argon and AFrame, see the [API Documentation](API.md).
## Builds
To use the latest stable build of Argon-AFrame, include [`argon-aframe.min.js`](https://rawgit.com/argonjs/argon-aframe/master/dist/argon-aframe.js):
```js
```
To check out the stable and master builds, see the [`dist/` folder](dist/).
## Local Development
```sh
git clone https://github.com/argonjs/argon-aframe.git # Clone the repository.
cd argon-aframe && npm install # Install dependencies.
npm run devsite # update build.js and genereate a local development site in _sites
npm run dev # Start the local development server.
```
And open in your browser **[http://localhost:8001](http://localhost:8001)**.
When you change the HTML files, you need to regenerate _site with `npm run devsite`.
### Generating Builds
```sh
npm run dist
```
## Questions
For questions and support, [ask on one of our support channels](https://www.argonjs.io/#develop).
## Stay in Touch
- To hang out with the community, join the argonjs slack ([see the slack-join link in our developer support links]](https://www.argonjs.io/#develop)).
- [Follow @argonjs on Twitter](https://twitter.com/argonjs).
## Contributing
Get involved! Check out the [Contributing Guide](CONTRIBUTING.md) for how to get started.
## License
This program is free software and is distributed under an [Apache License](LICENSE).