Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/argonjs/argon
An open-standards augmented reality platform for the web
https://github.com/argonjs/argon
argon augmented-reality web
Last synced: 10 days ago
JSON representation
An open-standards augmented reality platform for the web
- Host: GitHub
- URL: https://github.com/argonjs/argon
- Owner: argonjs
- License: apache-2.0
- Created: 2016-02-04T17:45:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-12T13:00:24.000Z (over 4 years ago)
- Last Synced: 2024-11-01T12:16:49.959Z (12 days ago)
- Topics: argon, augmented-reality, web
- Language: TypeScript
- Homepage: http://argonjs.io/
- Size: 8.79 MB
- Stars: 404
- Watchers: 42
- Forks: 73
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-AR - ArgonJS
README
# argon.js
An open-standards augmented reality platform for the web. Initially created to supporting creating AR web applications for [the Argon4 browser](https://app.argonjs.io), argon.js is now aimed at supporting AR in any web browser, using whatever capabilities are available on each platform.
*This software was created as part of a research project at the
Augmented Environments Lab at Georgia Tech. To support our research,
we request that if you make use of this software, you let us know
how you used it by sending mail to Blair MacIntyre ([email protected]).*
If you would like to help improve Argon4 and argon.js, you can see our current and future [Roadmap](https://trello.com/b/gBsEa8eg/argon-public-roadmap).
## Support
* [Documentation](https://docs.argonjs.io/)
* [API Reference](https://api.argonjs.io/)
## Quick Start
To install the argon.js library manually, include one of the following scripts in your project:
* argon.min.js [\[latest\]](https://unpkg.com/@argonjs/argon@^1/dist/argon.min.js) [\[dev\]](https://rawgit.com/argonjs/argon/develop/dist/argon.min.js) - includes WebVR polyfill
* argon.js [\[latest\]](https://unpkg.com/@argonjs/argon@^1/dist/argon.js) [\[dev\]](https://rawgit.com/argonjs/argon/develop/dist/argon.js) - includes WebVR polyfill
* argon.core.js [\[latest\]](https://unpkg.com/@argonjs/argon@^1/dist/argon.core.js) [\[dev\]](https://rawgit.com/argonjs/argon/develop/dist/argon.core.js)
> Note: These are UMD builds, meaning they should be compatible with standard module formats (commonjs, AMD, global). The [dev] link may point to an unstable build, and should only be used if you want the latest in-progress version from the develop branch.
To install with npm:
```sh
npm install @argonjs/argon@^1.0
```
To install with jspm:
```sh
jspm install npm:@argonjs/argon@^1.0
```
### Usage
In your es6 modules, `import` the package `"@argonjs/argon"`:
```js
import * as Argon from '@argonjs/argon'
```
If you aren't using es6 modules, `require` the package `"@argonjs/argon"`:
```js
var Argon = require('@argonjs/argon');
```
If you aren't using modules at all, no worries! The *argon.js* library will
create a global `Argon` variable that exposes the same API.
## Typescript
If you are using Typescript 2.0 and would like to leverage
*argon.js* typings (you should!), simply install *argon.js* using `npm`
as described above (even if you are not using modules in your
project). However, if you aren't using modules, just be sure
to include a triple-slash reference so that the typescript
compiler knows you are using *argon.js* globally:
```ts
///
```
Finally, make sure your `tsconfig.json` contains the following
compiler options:
```json
{
"compilerOptions": {
"moduleResolution": "node",
"lib": [
"dom",
"es2015"
]
}
}
```
After that, you can enjoy rich editing support for
*argon.js* in any editor that supports Typescript! We recommend
[Visual Studio Code](https://code.visualstudio.com).
## Build Guide
* Clone argon
```sh
git clone https://github.com/argonjs/argon.git
```
* Make sure you have node.js/npm installed (There are many guides for this online)
* Install jspm globally:
```sh
npm install jspm -g
```
* Go to the directory where you have argon.js downloaded and install dependencies
```sh
npm install
jspm install
```
* To run the typescript compiler and create a build, execute:
```sh
npm run build
```
* To test Argon, execute:
```sh
npm run test
```