@q-dev/q-ts-gdk-sdk v0.1.0
Documentation • GDK Contracts • Q Blockchain
Installation
Install package as dependency:
npm install --save @q-dev/q-gdk/q-ts-gdk-sdk
or
yarn add @q-dev/q-gdk/q-ts-gdk-sdk
Requirements
Local development
Install packages
npm install
Generate types
npm run generate-types
If generate-types indicates 0 matching files (on Windows machines) you can try the adapted script npm run generate-types-win
Contribute
Make sure to run pre-commit
script before commit
npm run pre-commit
Run tests
You may run tests via
npm run test
Get access to private Gitlab registry
Log in to GitLab NPM package registry. You need a gitlab personal access token with read_api
option enabled. This can be created via GitLab User Settings / Access Tokens.
npm config set '//gitlab.com/api/v4/packages/npm/:_authToken' <YOUR_ACCESS_TOKEN>
Furthermore, you need to tell npm that all q-dev
packages should be resolved via private gitlab registry. Create a file .npmrc
with the following content:
@q-dev:registry=https://gitlab.com/api/v4/packages/npm/
Code of Conduct
This project and everyone participating in it is governed by the TS GDK SDK Code of Conduct. By participating, you are expected to uphold this code.
Resources
License
2 years ago