Learning Tokens SDK

Tokenizing Formal and Informal Learning
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About Learning Tokens
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contracts
6. License
7. Contact
8. Acknowledgments

About Learning Tokens

Learning Tokens is an open-source mechanism that uses the composable Interwork Alliance Token Taxonomy Framework (IWA TTF) to produce a Learning Token as a positive reinforcer that recognizes, registers, and certifies skills acquisition and competencies while rewarding community engagement in collective learning.

Built With

• 
• 

(back to top)

Getting Started

Proceed with the following steps to get Learning Token SDK up and running on any device

Prerequisites

• npm

  npm install npm@latest -g

• yarn

  npm install yarn -g

Installation

1. Get a free API Key at
   • Yet to come🔜
2. Clone the repo

   git clone https://github.com/TanjinAlam/Learning-Token-SDK

3. Install packages

yarn install

Or

npm install

4. Create a .env file and enter fill up keys as per the dev.env

(back to top)

Usage

Build

npm run build

Test

npm test

Install in codebase

npm install learningTokenSDK

Usage

import { Client } from "learningTokenSDK";

const client = new Client("https://api.example.com");

async function getUser() {
  const response = await client.getUser(1);
  console.log(response.data);
}

getUser();

USER DOCUMENTATION

• Yet to come🔜

TECHNICAL DOCUMENTATION

• Yet to come🔜

Roadmap

• SDK Boilerplate
• SDK key creation
• Meet & Zoom configuration functions
• Pre-event data collection
• Post-event data collection
• Review Schema design

(back to top)

Contributing

Follow the steps below to contribute to Learning Token SDK

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (js git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Learning Tokens - learningtokens@hyperledger.org

Project Link: https://github.com/TanjinAlam/Learning-Token-SDK

(back to top)

Acknowledgments

• Best-README-Template

(back to top)