Skip to content

@soroban-react is a simple, powerful framework for building modern Soroban dApps using React.

License

Notifications You must be signed in to change notification settings

lmorgan824/soroban-react

 
 

Repository files navigation

@soroban-react

@soroban-react is a simple, powerful framework for building modern Soroban dApps using React.

Library created based on the code written by https://github.com/paulbellamy.

Packages

Package Version
@soroban-react/chains npm version
@soroban-react/connect-button npm version
@soroban-react/contracts npm version
@soroban-react/core npm version
@soroban-react/freighter npm version
@soroban-react/types npm version
@soroban-react/utils npm version
@soroban-react/wallet-data npm version

Introduction

@soroban-react is a simple, powerful framework for building modern Soroban dApps using React. Its marquee features are:

  • Full support for Freighter

  • A dev-friendly context containing the current account and chain, and more, available globally throughout your dApp via a React Context.

  • The ability to write custom, fully featured Connectors that manage every aspect of your dApp's connectivity with the Soroban blockchain and user accounts.

Usage:

See the official gitbook: https://soroban-react.gitbook.io/index/ You can also contribute to the Gitbook by editing the docs folder in this repo

Install:

Install all sub-packages with just yarn

Build and publish using lerna

Commit your changes with conventional commits with

commit -m "feat(SUB_PACKAGE_NAME): change"

Then

yarn build
yarn lerna-publish

This will

  • build the three projects in the right order
  • determine the current version of the packages
  • detect which packages have changed since the last publishing & then update its version in package.json accordingly
  • create a commit of the changed package.json files, tag the commit and push the tag & commit to the remote
  • publish the packages to NPM
  • add commit changes in CHANGELOG

Upgrade in your project:

yarn upgrade --latest --patern @soroban-react

Implementations

Projects using @soroban-react include:

Open a PR to add your project to the list! If you're interested in contributing .

About

@soroban-react is a simple, powerful framework for building modern Soroban dApps using React.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%