https://github.com/solarnetwork/sn-api-ssh-js
SolarNetwork SSH API - JavaScript
https://github.com/solarnetwork/sn-api-ssh-js
Last synced: about 1 year ago
JSON representation
SolarNetwork SSH API - JavaScript
- Host: GitHub
- URL: https://github.com/solarnetwork/sn-api-ssh-js
- Owner: SolarNetwork
- License: apache-2.0
- Created: 2017-07-18T00:30:48.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-04T10:05:19.000Z (over 3 years ago)
- Last Synced: 2025-03-18T13:59:03.108Z (about 1 year ago)
- Language: JavaScript
- Size: 561 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SolarNetwork SSH API - JavaScript
This project contains JavaScript code to help access [SolarSSH][solarssh-api].
# Building
The build uses [NPM][npm] or [yarn][yarn]. First, initialize the dependencies:
```shell
# NPM
npm install
# or, yarn
yarn install
```
Then you can run the `build` script:
```shell
# NPM
npm run build
# or, yarn
yarn run build
```
That will produce `lib/solarnetwork-api-ssh.js` and `lib/solarnetwork-api-ssh.min.js` bundles
of all sources, transpiled into an ES5 compatible UMD module, suitable for use in both browsers
and Node.
Additionally the build produces `lib/solarnetwork-api-ssh.es.js` and
`lib/solarnetwork-api-ssh.es.min.js` bundels of all sources, transpiled into an ES6 compatible
module, suitable for use in other projects with build tools that know how to use ES6 modules
(like Rollup or Webpack).
Finally, the non-transpiled source is available via the `lib.js` file which exports ES6
modules for all the modules in the project. This is suitable for use by other projects with
build tools that know how to use ES6 modules (like Rollup or Webpack) where you'd like to
transpile the source for a different target, for example ES2015.
# API docs
You can build the API documentation by running the `apidoc` script:
```shell
# NPM
npm run apidoc
# or, yarn
yarn run apidoc
```
That will produce HTML documentation in `docs/api`.
# Unit tests
The unit tests can be run by running the `test` script:
```shell
# NPM
npm test
# or, yarn
yarn test
# for more verbose output, add --verbose
yarn test -- --verbose
```
To generate a unit test code coverage report, run the `coverage` script:
```shell
# NPM
npm run coverage
# or, yarn
yarn run coverage
```
That will produce a HTML code coverage report at `coverage/index.html`.
[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/
[solarssh-api]: https://github.com/SolarNetwork/solarnetwork/wiki/SolarSSH-API