React SDK Introduction
Welcome to the docs page for Golem React SDK. Before you get started, make sure you have read the Introduction to the Task Model to get familiar with the Golem Network and the task model.
Who is this SDK for?
What can I build with this SDK?
The Golem React SDK provides a set of React hooks and components that make it easy to perform common tasks such as:
- Connecting to Yagna - use the useYagna hook to connect display the connection status and reconnect to Yagna if the connection is lost.
- Running tasks on the network - use the useExecutor hook to initialize and terminate executors and the useTask hook to run tasks on the network.
- Listing and handling invoices - use the useInvoices hook to list invoices and the useHandleInvoice hook to handle invoices.
- Listing and handling debit notes - use the useDebitNotes hook to list debit notes and the useHandleDebitNote hook to handle debit notes.
If you want to learn more about each of the hooks and components provided by the SDK, check out the API reference.
To help you get started we have created an example application that uses every hook and component provided by the SDK. You can find the source code for the example app on GitHub. Feel free to clone the repository and play around with the code. Follow the instructions in the README to run the app locally.
The source code for the SDK along with an example app is available on GitHub and we welcome contributions.
To get started with the SDK, check out the Getting started guide.
Was this helpful?