/sdk

SDK to interact with the gum program library.

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

gum-sdk-monorepo

Getting Started

  1. Clone the repository:
git clone https://github.com/gumhq/sdk.git
  1. Install Lerna (if you haven't already):
npm install -g lerna
  1. Install dependencies and link packages:
cd sdk
npx lerna bootstrap
  1. Build the packages:
npx lerna run build

Packages

Name Description Version
@gumhq/sdk Typescript client to interact with Gum protocol.

npm

@gumhq/react-sdk React Hooks for Gum protocol

npm

Documentation

You can find the complete documentation for the Gum SDK at https://docs.gum.fun/

Example App

Check out the example app that uses the Gum SDK to demonstrate its capabilities. The app is a simple React app that showcases the creation of a user, profile, and post.

Contributing

We welcome contributions to improve the SDK. Please raise an issue or submit a pull request with any suggestions or bug fixes.

License

The Gum SDK is licensed under the GNU General Public License v3.0.

Support

Join our Discord community at https://discord.gg/tCswbSK5W2 for any questions or support.