https://github.com/luos-io/sdk-ts

A Typescript library to program a Luos based network through a high level interface.
https://github.com/luos-io/sdk-ts

luos sdk sdk-typescript typescript

Last synced: about 2 months ago
JSON representation

A Typescript library to program a Luos based network through a high level interface.

• Host: GitHub
• URL: https://github.com/luos-io/sdk-ts
• Owner: Luos-io
• License: apache-2.0
• Created: 2021-09-06T15:18:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-18T04:21:17.000Z (over 1 year ago)
• Last Synced: 2024-04-16T08:45:22.022Z (9 months ago)
• Topics: luos, sdk, sdk-typescript, typescript
• Language: TypeScript
• Homepage: https://www.luos.io
• Size: 128 KB
• Stars: 14
• Watchers: 6
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LUOS SDK TS

## Development

### Requirements

1. [NodeJS](https://nodejs.org/) version LTS 14+

2. [Yarn](https://yarnpkg.com/) version 1.22+

### Installation

Install the dependancies with the command : `yarn install`.

### Run

### Developement

Execute the command : `yarn dev`.

The command is underlaying multiple actions :

- Executing the typescript runtime `tsc` in watch mode.

- Executing the plugin runtime `tsc-alias` in watch mode to convert absolute paths into relative ones.

- Executing the `rollup` packager in watch mode to create :

  - UMD bundle for browser usage on the frontend : `index.umd.js`

  - ESModule bundle for the backend usage like our CLI : `index.esm.js`

## Contribute

### Workflow

You can use [ACT](https://github.com/nektos/act#installation-through-package-managers) to validate the workflows locally :

1. Install ACT (See link for other systems):

```sh

brew install act

```

2. Setup secrets variables in the `.act/.secrets` file :

```yml

NPM_TOKEN=

GITHUB_TOKEN=

```