Regen-JS

Regen Network does JavaScript

This monorepo contains JavaScript libraries and UIs for interacting with the Regen Ledger.

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

🚧 Warning

This API is still under heavy construction, be ready for unexpected breaking changes.

Get Started

Install and build

# Clone the repo.
git clone https://github.com/regen-network/regen-js

# Install dependencies.
yarn install

# Make sure to run this command to build the `api` package, so that other
# packages can reference it. Or else, some TypeScript references won't be
# available statically.
yarn build:api

Starting the demo app

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 @regen-network/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.

Running the tests:

yarn test

Pro tip 💡: if want to run the api tests with a debugger use this command (and then access your debugging tool, i.e. chrome://inspect):

node --inspect-brk node_modules/.bin/jest -c packages/api/jest.config.js --runInBand

Packages

Regen-JS consists of smaller npm packages within the @regen-network namespace, a so called monorepo. Here is the list of all packages.

Package	Description	Latest
@regen-network/api	A client library interacting with the Regen Ledger.
@regen-network/api-demo	A demo React app using @regen-network/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.