Skip to content
This repository has been archived by the owner on Apr 30, 2021. It is now read-only.
/ isso-clientlib Public archive

A client library to interact with the isso commenting server

License

Notifications You must be signed in to change notification settings

jGleitz/isso-clientlib

Repository files navigation

isso-clientlib Build Status codecov

A client library to interact with the isso commenting server. API Documentation

Development

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:

Testing

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.

Prerequisite

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-venv

Scripts

To 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

About

A client library to interact with the isso commenting server

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published