https://github.com/regen-network/regen-js
:seedling: JavaScript API for Regen Ledger
https://github.com/regen-network/regen-js
api blockchain
Last synced: 6 months ago
JSON representation
:seedling: JavaScript API for Regen Ledger
- Host: GitHub
- URL: https://github.com/regen-network/regen-js
- Owner: regen-network
- License: apache-2.0
- Created: 2020-11-19T09:57:12.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-12-30T09:08:49.000Z (6 months ago)
- Last Synced: 2026-01-02T21:58:35.267Z (6 months ago)
- Topics: api, blockchain
- Language: TypeScript
- Homepage:
- Size: 6.48 MB
- Stars: 15
- Watchers: 14
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/regen-network/regen-js/actions)
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
```bash
# 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:
```bash
# 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](https://www.npmjs.com/org/regennetwork), a so called monorepo. Here is the list of all packages.
| Package | Description | Latest |
|------------------------------------------------| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| [`@regen-network/api`](packages/api) | A client library interacting with the Regen Ledger. | [](https://www.npmjs.com/package/@regen-network/api) |
| [`@regen-network/api-demo`](packages/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.