Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Folks-Finance/folks-finance-js-sdk
The official JavaScript SDK for the Folks Finance Algorand Protocol
https://github.com/Folks-Finance/folks-finance-js-sdk
Last synced: 3 months ago
JSON representation
The official JavaScript SDK for the Folks Finance Algorand Protocol
- Host: GitHub
- URL: https://github.com/Folks-Finance/folks-finance-js-sdk
- Owner: Folks-Finance
- License: mit
- Created: 2022-03-02T18:29:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T16:41:06.000Z (5 months ago)
- Last Synced: 2024-11-14T06:42:09.649Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 4.73 MB
- Stars: 35
- Watchers: 8
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# folks-finance-js-sdk
The official JavaScript SDK for the Folks Finance Protocol
## Installation
Using [Node.js](https://nodejs.org/en/download/):
```
npm install folks-finance-js-sdk
```
## Documentation
Documentation for this SDK is available at https://folks-finance.github.io/folks-finance-js-sdk/.
## Running examples
Portions of the codebase are written in TypeScript, so running examples requires ts-node, an npm package that runs TypeScript files directly. To make this easier for the user, we've included an example alias for ts-node in the project's package.json scripts:
```
$ npm run example examples/v2/liquidate.ts
```
Make sure to set your desired configuration in `examples/config.ts` first.