kards-tools

Library used for interacting with the kards backend

Includes other library functions that are used by multiple kards-stats projects

Cloning

After cloning the repo, apart from the normal npm i, it is required to run npm run dev:generate and is advised to also run npm run clean

Usage

Development is changing the way this module works, check tests and source code to see how it is used in its current form. Sorry :/

Testing

Due to the nature of this project and the fact that this project uses un-documented API routes, the released package will never be garaunteed stable.

These tests use sensative information (usernames and passwords to log into kards), these have been placed in json files with example json files published to git.

To run the tests, simply rename all *.example.json to *.json and fill in any information, then run npm run test which will clean and build then test.

Versioning

All NPM release source can be found in the releases section.

Pre v1 (0.x.x-alpha) Alpha releases do NOT follow semantic versioning instead of .. they follow 0.. as functionality was changing during development

Commiting

This repo along with all kards-stats active repos use standard or ts-standard to format files. Please follow it.