{"id":22326018,"url":"https://github.com/solarnetwork/sn-api-ssh-js","last_synced_at":"2025-03-26T06:11:44.489Z","repository":{"id":22911303,"uuid":"97534470","full_name":"SolarNetwork/sn-api-ssh-js","owner":"SolarNetwork","description":"SolarNetwork SSH API - JavaScript","archived":false,"fork":false,"pushed_at":"2022-12-04T10:05:19.000Z","size":574,"stargazers_count":0,"open_issues_count":9,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-18T13:59:03.108Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/SolarNetwork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-18T00:30:48.000Z","updated_at":"2020-07-30T12:43:43.000Z","dependencies_parsed_at":"2023-01-14T00:15:14.451Z","dependency_job_id":null,"html_url":"https://github.com/SolarNetwork/sn-api-ssh-js","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Fsn-api-ssh-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Fsn-api-ssh-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Fsn-api-ssh-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolarNetwork%2Fsn-api-ssh-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SolarNetwork","download_url":"https://codeload.github.com/SolarNetwork/sn-api-ssh-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245598320,"owners_count":20641884,"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-12-04T02:15:04.522Z","updated_at":"2025-03-26T06:11:44.468Z","avatar_url":"https://github.com/SolarNetwork.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SolarNetwork SSH API - JavaScript\n\nThis project contains JavaScript code to help access [SolarSSH][solarssh-api].\n\n# Building\n\nThe build uses [NPM][npm] or [yarn][yarn]. First, initialize the dependencies:\n\n```shell\n# NPM\nnpm install\n\n# or, yarn\nyarn install\n```\n\nThen you can run the `build` script:\n\n```shell\n# NPM\nnpm run build\n\n# or, yarn\nyarn run build\n```\n\nThat will produce `lib/solarnetwork-api-ssh.js` and `lib/solarnetwork-api-ssh.min.js` bundles\nof all sources, transpiled into an ES5 compatible UMD module, suitable for use in both browsers\nand Node.\n\nAdditionally the build produces `lib/solarnetwork-api-ssh.es.js` and \n`lib/solarnetwork-api-ssh.es.min.js` bundels of all sources, transpiled into an ES6 compatible\nmodule, suitable for use in other projects with build tools that know how to use ES6 modules\n(like Rollup or Webpack).\n\nFinally, the non-transpiled source is available via the `lib.js` file which exports ES6\nmodules for all the modules in the project. This is suitable for use by other projects with\nbuild tools that know how to use ES6 modules (like Rollup or Webpack) where you'd like to\ntranspile the source for a different target, for example ES2015.\n\n# API docs\n\nYou can build the API documentation by running the `apidoc` script:\n\n```shell\n# NPM\nnpm run apidoc\n\n# or, yarn\nyarn run apidoc\n```\n\nThat will produce HTML documentation in `docs/api`.\n\n# Unit tests\n\nThe unit tests can be run by running the `test` script:\n\n```shell\n# NPM\nnpm test\n\n# or, yarn\nyarn test\n\n# for more verbose output, add --verbose\nyarn test -- --verbose\n```\n\nTo generate a unit test code coverage report, run the `coverage` script:\n\n```shell\n# NPM\nnpm run coverage\n\n# or, yarn\nyarn run coverage\n```\n\nThat will produce a HTML code coverage report at `coverage/index.html`.\n\n  [npm]: https://www.npmjs.com/\n  [yarn]: https://yarnpkg.com/\n  [solarssh-api]: https://github.com/SolarNetwork/solarnetwork/wiki/SolarSSH-API\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolarnetwork%2Fsn-api-ssh-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolarnetwork%2Fsn-api-ssh-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolarnetwork%2Fsn-api-ssh-js/lists"}