Circles SDK Svelte Examples

This is a SvelteKit project that demonstrates how to use the Circles SDK. It is referenced by the Circles SDK documentation.

The examples are bare bones, self-contained and are targeted to be run in a browser with MetaMask installed. The examples are:

• Using avatars
  This example demonstrates how to use the Circles SDK to sign up at Circles and display basic information about the avatar. (see Using Avatars in the docs)
• Avatar information
  This example demonstrates how to use the Circles SDK to get information about an avatar. The information includes:
  • Balance
  • Mintable amount
  • Trust relations
  • Transaction history
    (see Avatar information in the docs)
• Interact with other avatars
  This example demonstrates how to use the Circles SDK to interact with other avatars. The interactions include:
  • Trusting and untrusting another avatar
  • Minting personal Circles
  • Sending tokens to another avatar
    (see Interact with other avatars in the docs)

Run

1. Pre-requisites

• Install Git
• Install Node.js
• Install MetaMask and create an account
• Get some xDAI (e.g. from a faucet) and send it to your MetaMask account

2. Clone the repository

git clone https://github.com/aboutcircles/circles-sdk-svelte-examples.git

3. Install dependencies

cd circles-sdk-svelte-examples
npm install

4. Start the development server

npm run dev -- --open