{"id":17597908,"url":"https://github.com/cvan/websdk","last_synced_at":"2025-03-29T20:27:47.528Z","repository":{"id":137964817,"uuid":"87271463","full_name":"cvan/websdk","owner":"cvan","description":"The Universal SDK for Web Applications.","archived":false,"fork":false,"pushed_at":"2017-04-05T07:09:48.000Z","size":49,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-24T09:50:19.699Z","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":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cvan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-05T05:54:15.000Z","updated_at":"2023-06-25T06:55:14.000Z","dependencies_parsed_at":"2023-03-22T05:49:59.219Z","dependency_job_id":null,"html_url":"https://github.com/cvan/websdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Fwebsdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Fwebsdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Fwebsdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cvan%2Fwebsdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cvan","download_url":"https://codeload.github.com/cvan/websdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246240506,"owners_count":20745879,"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":[],"created_at":"2024-10-22T09:44:01.586Z","updated_at":"2025-03-29T20:27:47.501Z","avatar_url":"https://github.com/cvan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebSDK\n\nThe Universal SDK for Web Applications.\n\n\n## Features\n\n* Written using [Webpack (version 2)](https://webpack.js.org/).\n* JavaScript source code written in [ES6](http://es6-features.org/).\n* Exports an [UMD](https://github.com/umdjs/umd) format, so the library works everywhere.\n* ES6-based test setup using [Mocha](https://mochajs.org/) and [Chai](http://chaijs.com/).\n* Linting with [Semistandard](http://eslint.org/).\n\n\n## Local development\n\n### Installation\n\n1. Install [Node.js](https://nodejs.org/en/download/package-manager/) (which includes [npm](https://www.npmjs.com/)), if you haven't already.\n2. Clone this repository ([`WebVRRocks/moonrise`](https://github.com/WebVRRocks/moonrise)):\n\n    ```bash\n    mkdir -p websdk\n    git clone git@github.com:cvan/websdk.git websdk/websdk\n    ```\n3. In the root directory of the cloned repository of the project, install the [Node](https://nodejs.org/en/download/package-manager/) dependencies:\n\n    ```bash\n    cd websdk/websdk/\n    npm install\n    ```\n\n4. From the `websdk/websdk/` directory, run these commands:\n\n    ```bash\n    # Start application for local development (w/ live-reloading, error handling).\n    npm start\n\n    # Generate packaged modules for distribution.\n    npm run dist\n    ```\n\n### Process\n\n```\nES6 source files\n       |\n       |\n    webpack\n       |\n       +--- babel, eslint\n       |\n  ready-to-use\n     library\n  in UMD format\n```\n\n\u003e **NOTE:** The library must be built before publishing. The files under the `dist` folder are the ones that should be distributed.\n\n### Building\n\nTo install the project's latest Node dependencies:\n\n```sh\nnpm install\n```\n\nTo generate the minified version of the library:\n\n```sh\nnpm run build\n```\n\n### Development\n\nWhen all the latest dependencies are installed, run `npm start` (or `npm run dev`). This will generate a non-minified version of the library and will run a watcher so you get the compilation on file change.\n\n### Tests\n\nTo run the tests:\n\n```sh\nnpm run test\n```\n\n### Scripts\n\n* **`npm run dist`** – builds the distribution-ready production version of the library under the `dist` folder.\n* **`npm run build`** – builds the production version of the library under the `build` folder.\n* **`npm start`** – builds the development version of the library and runs a file watcher.\n* **`npm run test`** – runs tests.\n* **`npm run test:watch`** – runs tests in a continuous watch mode.\n\n\n## Acknowledgments\n\nThank you to the following projects and individuals:\n\n* [`webpack-library-starter](https://github.com/krasimir/webpack-library-starter) (Licensed under [MIT](https://github.com/krasimir/webpack-library-starter/blob/master/LICENSE))\n\n\n## Contributing\n\n[Contributions are very welcome!](CONTRIBUTING.md)\n\n\n## License\n\nAll code and content within this source-code repository is licensed under the [**Creative Commons Zero v1.0 Universal** license (CC0 1.0 Universal; Public Domain Dedication)](LICENSE.md).\n\nYou can copy, modify, distribute and perform this work, even for commercial purposes, all without asking permission.\n\nFor more information, refer to these following links:\n\n* a copy of the [license](LICENSE.md) in [this source-code repository](https://github.com/webvrrocks/moonrise)\n* the [human-readable summary](https://creativecommons.org/publicdomain/zero/1.0/) of the [full text of the legal code](https://creativecommons.org/publicdomain/zero/1.0/legalcode)\n* the [full text of the legal code](https://creativecommons.org/publicdomain/zero/1.0/legalcode)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcvan%2Fwebsdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcvan%2Fwebsdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcvan%2Fwebsdk/lists"}