{"id":13531204,"url":"https://github.com/argonjs/argon","last_synced_at":"2025-04-01T19:31:48.841Z","repository":{"id":42188213,"uuid":"51093743","full_name":"argonjs/argon","owner":"argonjs","description":"An open-standards augmented reality platform for the web","archived":false,"fork":false,"pushed_at":"2020-08-12T13:00:24.000Z","size":9221,"stargazers_count":405,"open_issues_count":48,"forks_count":73,"subscribers_count":42,"default_branch":"master","last_synced_at":"2025-03-04T02:26:05.808Z","etag":null,"topics":["argon","augmented-reality","web"],"latest_commit_sha":null,"homepage":"http://argonjs.io/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/argonjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-04T17:45:47.000Z","updated_at":"2024-12-24T01:32:47.000Z","dependencies_parsed_at":"2022-09-05T15:01:10.852Z","dependency_job_id":null,"html_url":"https://github.com/argonjs/argon","commit_stats":null,"previous_names":[],"tags_count":124,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/argonjs%2Fargon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/argonjs%2Fargon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/argonjs%2Fargon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/argonjs%2Fargon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/argonjs","download_url":"https://codeload.github.com/argonjs/argon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246700451,"owners_count":20819874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["argon","augmented-reality","web"],"created_at":"2024-08-01T07:01:00.887Z","updated_at":"2025-04-01T19:31:43.831Z","avatar_url":"https://github.com/argonjs.png","language":"TypeScript","readme":"# argon.js\n\nAn 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.\n\n*This software was created as part of a research project at the \nAugmented Environments Lab at Georgia Tech.  To support our research, \nwe request that if you make use of this software, you let us know \nhow you used it by sending mail to Blair MacIntyre (blair@cc.gatech.edu).*\n\nIf 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).\n\n## Support\n\n* [Documentation](https://docs.argonjs.io/)\n* [API Reference](https://api.argonjs.io/)\n\n## Quick Start\n\nTo install the argon.js library manually, include one of the following scripts in your project:\n\n* 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\n* 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 \n* 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)\n\n\u003e 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. \n\nTo install with npm:\n\n```sh\nnpm install @argonjs/argon@^1.0\n```\n\nTo install with jspm:\n\n```sh\njspm install npm:@argonjs/argon@^1.0\n```\n\n### Usage\n\nIn your es6 modules, `import` the package `\"@argonjs/argon\"`:\n\n```js\nimport * as Argon from '@argonjs/argon'\n```\n\nIf you aren't using es6 modules, `require` the package `\"@argonjs/argon\"`:\n\n```js\nvar Argon = require('@argonjs/argon');\n```\n\nIf you aren't using modules at all, no worries! The *argon.js* library will\ncreate a global `Argon` variable that exposes the same API. \n\n## Typescript\n\nIf you are using Typescript 2.0 and would like to leverage \n*argon.js* typings (you should!), simply install *argon.js* using `npm` \nas described above (even if you are not using modules in your \nproject). However, if you aren't using modules, just be sure\nto include a triple-slash reference so that the typescript \ncompiler knows you are using *argon.js* globally:\n\n```ts\n/// \u003creference types=\"@argonjs/argon\" /\u003e\n```\n\nFinally, make sure your `tsconfig.json` contains the following \ncompiler options:\n\n```json\n{\n    \"compilerOptions\": {\n        \"moduleResolution\": \"node\",\n        \"lib\": [\n            \"dom\",\n            \"es2015\"\n        ]\n    }\n}\n```\n\nAfter that, you can enjoy rich editing support for\n*argon.js* in any editor that supports Typescript! We recommend \n[Visual Studio Code](https://code.visualstudio.com).\n\n## Build Guide\n\n* Clone argon\n\n```sh\ngit clone https://github.com/argonjs/argon.git\n```\n\n* Make sure you have node.js/npm installed (There are many guides for this online)\n* Install jspm globally:\n\n```sh\nnpm install jspm -g\n```\n\n* Go to the directory where you have argon.js downloaded and install dependencies\n\n```sh\nnpm install\njspm install\n```\n\n* To run the typescript compiler and create a build, execute:  \n\n```sh\nnpm run build\n```\n\n* To test Argon, execute: \n \n```sh\nnpm run test\n```\n","funding_links":[],"categories":["Frameworks \u0026 Libraries","TypeScript","Libraries/Frameworks/Tools"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fargonjs%2Fargon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fargonjs%2Fargon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fargonjs%2Fargon/lists"}