stargaze-js

README

Stargaze-JS

This monorepo contains JavaScript libraries and UIs for interacting with the Stargaze Blockchain.

"JS" is short for runs everywhere – we actually develop in TypeScript.

🚧 This API is still under heavy construction, be ready for unexpected breaking changes. Stargaze-js is a fork of Regen-js.

Get Started

# Clone the repo.
git clone https://github.com/public-awesome/stargaze-js

# Install dependencies.
yarn install

# Make sure to run this command, or else some TypeScript references won't be
# available statically.
yarn build:api

Then, to run the React app, just run the following command:

# Start the React app.
yarn start

The app should be running on http://localhost:3000.

Pro tip 💡: everytime you modify the @stargazefi/api package, be sure to run again yarn build:api, to let the other packages in the monorepo be aware of your latest changes. You can also add to --watch flag on this command to build on file change.

Packages

Stargaze-JS consists of many smaller npm packages within the @stargazefi namespace, a so called monorepo. Here is the list of all packages.

Package	Description	Latest
@stargazefi/api	A client library interacting with Stargaze.
@stargazefi/demo-app	A demo React app using @stargazefi/api.	Not published on npm.

Build the packages from source

To build all the packages, just run yarn build from the root folder. You may also build them individually by going into each package's directory, and running yarn build from there.