https://github.com/respoke/node-respoke-admin
This is the Node.js library that wraps the HTTP and WebSocket API provided by Respoke.
https://github.com/respoke/node-respoke-admin
Last synced: about 1 year ago
JSON representation
This is the Node.js library that wraps the HTTP and WebSocket API provided by Respoke.
- Host: GitHub
- URL: https://github.com/respoke/node-respoke-admin
- Owner: respoke
- License: mit
- Created: 2014-08-20T17:29:55.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-08-28T14:49:52.000Z (almost 9 years ago)
- Last Synced: 2025-03-25T08:38:15.388Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://docs.respoke.io
- Size: 510 KB
- Stars: 6
- Watchers: 10
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/respoke-admin)
[](https://travis-ci.org/respoke/node-respoke-admin)
# respoke-admin
This wraps the [Respoke][respoke] HTTP and WebSocket API's for use in a Node.js
app or server.
[respoke]: https://respoke.io "respoke.io"
## Usage
Install using npm.
```bash
npm install --save respoke-admin
```
## Documentation
- node-respoke-admin module documentation: [node-respoke-admin documentation][node-respoke-admin]
- Respoke.io documentation: [respoke.io full documentation][respoke-docs]
[node-respoke-admin]: https://respoke.github.io/node-respoke-admin "node-respoke-admin documentation"
[respoke-docs]: https://docs.respoke.io "full respoke documentation"
## Testing
Before you can run the functional tests you will need to complete the following
steps.
- create a test app in the your admin portal at [respoke.io][respoke]
- turn *off* dev mode
- create a new blank role (name value is not important)
- `cp spec/config.example.json spec/config.json`
- fill in the information in the `spec/helpers.js` file
There are several commands to run the tests.
```bash
# run all tests
npm test
# run all tests with extra debug output
npm run debug-test
# run only unit tests
npm run unit
# run only functional tests
npm run functional
```
#### Building and viewing the source documentation
```bash
npm run docs
```
## License
Copyright 2014-2016, Digium, Inc.
All rights reserved.
This source code is licensed under The MIT License found in the
[LICENSE](LICENSE) file in the root directory of this source tree.
For all details and documentation: https://www.respoke.io