Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ripio/sdkjs

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/ripio/sdkjs
Owner: ripio
License: apache-2.0
Created: 2022-10-03T13:35:26.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-10-20T10:54:17.000Z (about 1 year ago)
Last Synced: 2024-04-24T20:03:39.555Z (8 months ago)
Language: TypeScript
Size: 1.96 MB
Stars: 4
Watchers: 6
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![codecov](https://codecov.io/github/ripio/sdkjs/branch/main/graph/badge.svg?token=CTSO4X4EIP)](https://codecov.io/github/ripio/sdkjs)

# Setup

## Install node

**Recommended version: 16.14.0 (LTS)**

- **Mac OS:** You can download it from `https://nodejs.org/en/`

- **Linux:** follow instructions `https://nodejs.org/en/download/package-manager/` or use a version manager like nvm `https://github.com/nvm-sh/nvm`

## Install dependencies

```bash

npm install

```

## Run tests

```bash

npm run test

```

## Development console

## Ts-node

Interactive shell to test features or just run code

```bash

npx ts-node

```

# Deploy a new version of the sdk

The deploys are automatically done by merging using semantic-release.

Follow the [commit style guide](https://github.com/semantic-release/semantic-release#how-does-it-work) so the commits will be added to the changelog.

# Documentation

Read the [docs](https://ripio.github.io/sdkjs) on github pages.

- [sdk](https://ripio.github.io/sdkjs/sdk)

- [sdk nft](https://ripio.github.io/sdkjs/sdk-nft)

- [sdk storage aws](https://ripio.github.io/sdkjs/sdk-storage-aws)

- [sdk storage http](https://ripio.github.io/sdkjs/sdk-storage-http)

- [sdk storage ipfs](https://ripio.github.io/sdkjs/sdk-storage-ipfs)