Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gumhq/sdk
SDK to interact with the gum program library.
https://github.com/gumhq/sdk
react social social-graph solana typescript
Last synced: 9 days ago
JSON representation
SDK to interact with the gum program library.
- Host: GitHub
- URL: https://github.com/gumhq/sdk
- Owner: gumhq
- License: gpl-3.0
- Archived: true
- Created: 2023-01-16T17:53:24.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-03T12:04:22.000Z (over 1 year ago)
- Last Synced: 2025-01-10T07:37:56.019Z (20 days ago)
- Topics: react, social, social-graph, solana, typescript
- Language: TypeScript
- Homepage: https://gumhq.github.io/sdk/
- Size: 1020 KB
- Stars: 19
- Watchers: 1
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# gum-sdk-monorepo
## Getting Started
1. Clone the repository:
```bash
git clone https://github.com/gumhq/sdk.git
```
2. Install Lerna (if you haven't already):
```bash
npm install -g lerna
```
3. Install dependencies and link packages:
```bash
cd sdk
npx lerna bootstrap
```
4. Build the packages:
```bash
npx lerna run build
```
## Packages
| Name | Description | Version |
| --------------------------------------------------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
| [`@gumhq/sdk`](https://github.com/gumhq/sdk/tree/master/packages/gpl-core) | Typescript client to interact with Gum protocol. |
|
| [`@gumhq/react-sdk`](https://github.com/gumhq/sdk/tree/master/packages/react-sdk) | React Hooks for Gum protocol | 
|
## Documentation
- [Overview](https://docs.gum.fun/introduction/overview)
- [Getting Started Guide](https://docs.gum.fun/protocol-overview/quickstart)
- [FAQ](https://docs.gum.fun/introduction/faqs)
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](https://github.com/gumhq/gum-quickstart) to get started.
## Example App
Check out the [example app](https://github.com/gumhq/gum-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](https://github.com/gumhq/sdk/blob/master/LICENSE).
## Support
Join our Discord community at [https://discord.gg/tCswbSK5W2](https://discord.gg/tCswbSK5W2) for any questions or support.