Skip to content
This repository has been archived by the owner on Oct 28, 2023. It is now read-only.
/ angotia-sdk Public archive

Software Development Kit for Angotia ecosystem which provides common utils, contracts etc.

Notifications You must be signed in to change notification settings

Poyters/angotia-sdk

Repository files navigation

Angotia SDK

Angotia SDK is a TypeScript library that provides a common (around Angotia game ecosystem) entities like: utils, interfaces, models etc. It useses axios to provide HTTP communnication across Node and Web projects. To run it locally, use yalc.

Commands

# run unit tests
$ npm run test

# watch unit tests
$ npm run test:watch

# full build
$ npm run yalc-publish

# full build + documentation + pushing library to attached locally repos
$ npm run yalc-publish

# generate documentation based on current build
$ npm run doc

# lint a whole library by eslint
$ npm run lint

Support

Library supports below technology stacks:

  1. Next.js + Typescript (Node)
  2. Nest.js + Fastify (Node)
  3. React.js 17.x + Babel 7.x (Web)

Data fetching

Angotia SDK provides some functions for fetching resources over Internet. To provide support for web and Node applications, SDK uses axios library internally.

Turn on internal library logger

To enable library logger, add below variable to .env file inside your project:

# Node.js projects
$ SDK_LOGGER=ENABLED

# Next.js projects
$ NEXT_PUBLIC_SDK_LOGGER=ENABLED

# React.js projects
$ REACT_APP_SDK_LOGGER=ENABLED

Attach SDK to another project

$ yalc add angotia-sdk

About

Software Development Kit for Angotia ecosystem which provides common utils, contracts etc.

Resources

Stars

Watchers

Forks

Packages

No packages published