memxor/sdk

SDK to interact with the gum program library.

gum-sdk-monorepo

Getting Started

1. Clone the repository:

git clone https://github.com/gumhq/sdk.git

2. Install Lerna (if you haven't already):

npm install -g lerna

3. Install dependencies and link packages:

cd sdk
npx lerna bootstrap

4. Build the packages:

npx lerna run build

Packages

Name	Description	Version
@gumhq/sdk	Typescript client to interact with Gum protocol.
@gumhq/react-sdk	React Hooks for Gum protocol

Documentation

• Overview
• Getting Started Guide
• FAQ

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

Gum Quickstart

The Gum Quickstart is an excellent starting point for developers aiming to leverage Gum in their Next.js applications. This ready-to-use template not only expedites the setup process, but also includes functional examples and components to facilitate the creation of domain profiles, posts, and more. Check out the Gum Quickstart to get started.

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 domain, profile, and posts.

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.