https://github.com/threefoldtech/tfgrid-sdk-ts

https://github.com/threefoldtech/tfgrid-sdk-ts

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/threefoldtech/tfgrid-sdk-ts
• Owner: threefoldtech
• License: apache-2.0
• Created: 2023-04-11T14:37:02.000Z (about 2 years ago)
• Default Branch: development
• Last Pushed: 2025-04-09T16:14:59.000Z (about 1 month ago)
• Last Synced: 2025-04-09T17:10:05.203Z (about 1 month ago)
• Language: HTML
• Size: 19.5 MB
• Stars: 5
• Watchers: 15
• Forks: 8
• Open Issues: 285
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# tfgrid-sdk-ts

![Version](https://img.shields.io/github/lerna-json/v/threefoldtech/tfgrid-sdk-ts/development?color=blue&label=version)

[![Lint](https://github.com/threefoldtech/tfgrid-sdk-ts/actions/workflows/lint.yml/badge.svg)](https://github.com/threefoldtech/tfgrid-sdk-ts/actions/workflows/lint.yml)

[![Build](https://github.com/threefoldtech/tfgrid-sdk-ts/actions/workflows/build.yml/badge.svg)](https://github.com/threefoldtech/tfgrid-sdk-ts/actions/workflows/build.yml)

[![Code Coverage](https://codecov.io/gh/threefoldtech/tfgrid-sdk-ts/branch/development/graph/badge.svg)](https://codecov.io/gh/threefoldtech/tfgrid-sdk-ts)

This repo contains the typescript clients and projects for Threefold grid.

## Packages

- [stats](./packages/stats/README.md)

- [grid client](./packages/grid_client/README.md)

- [grid http server](./packages/grid_http_server/README.md)

- [grid rmb server](./packages/grid_rmb_server/README.md)

- [rmb direct client](./packages/rmb_direct_client/README.md)

- [rmb peer client](./packages/rmb_peer_client/README.md)

- [rmb peer server](./packages/rmb_peer_server/README.md)

- [Playground](./packages/playground/README.md)

- [graphql_client](./packages/graphql_client/README.md)

- [gridproxy_client](./packages/gridproxy_client/README.md)

- [UI](./packages/UI/README.md)

## Requirements

The main requirements are:

- [Node.js](https://nodejs.org/en) ^18

- [Lerna](https://lerna.js.org/) 7.1.1

## Install

```bash

yarn install

```

> **Note:** If the used Python version is 3.12 or later, you need to install setuptools.

```bash

python3 -m pip install setuptools

```

## Build

```bash

yarn lerna run build

```

> If the build fails due to a memory issue, please use the following command

```bash

export NODE_OPTIONS="--max-old-space-size=8192"

```

## Related Documentations

- [Configure the editor/IDE](./docs/editor_config.md)

- [Pipelines documentation](./docs/workflows.md)

- [Release process](./docs/release.md)