/trueblocks-sdk

A typescript SDK for use with the trueblocks-core API server

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

TrueBlocks SDKs

GitHub repo size GitHub contributors GitHub stars GitHub forks Twitter Follow

Table of Contents

Introduction

This repo holds auto-generated SDKs based on the TrueBlocks API. This SDK is intended for use by the core developers of TrueBlocks as we develop our own applications, and is therefore purposefully not well documented. This is so we do not create an unwanted support burden for our team. You are welcome to use the SDK, but we will do not provide technical support.

However, we do welcome issues and PR's (particularly documentation) from the community.

The SDKs

There are two SDKs so far:

Docker version

These SDKs are easiest to use with our docker version which is in a separate repo. Please see that repo for information on running with Docker.

Documentation

The TrueBlocks documentation repo builds the TrueBlocks website. See our website for the best available documentation.

Contributing

A chart showing the number of stars on our repo over time.

We love contributors. Please see information about our work flow before proceeding.

  1. Fork this repository into your own repo.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make changes to your local branch and commit them to your forked repo: git commit -m '<commit_message>'
  4. Push back to the original branch: git push origin TrueBlocks/trueblocks-sdk
  5. Create the pull request.

Contact

If you have questions, comments, or complaints, please join the discussion on our discord server which is linked from our website.

List of Contributors

Thanks to the following people who have contributed to this project: