A client library to interact with the isso commenting server. API Documentation
This library is written in TypeScript. To get started, install Node.js and npm and run npm install in the project folder.
Relevant projects and libraries are:
- SuperAgent, the HTTP library
- ts-events for asynchronous events
- jest, the test framework
- ts-lint, used for checking the code for style
- typedoc to render the API Documentation
Tests are very important to this project. It’s intended to be a library users can rely on. The library is tested using both unit and integration tests. The integration test spins up real isso instance to make sure the library is always compatible to the latest version of isso.
In order to run the integration test, you need to install python, the python headers and virtualenv. On Debian/Ubuntu, run:
sudo apt install python3 python3-dev python3-venvTo check the code, you can use these tasks:
| Task | Description |
|---|---|
npm test |
run all checks |
npm start |
start the jest in watch mode to continuously run the unit tests on changed code |
npm run lint |
lint the code |
npm run unit-test |
run only unit tests |
npm run integration-test |
run only the integration test |