Giter Club home page Giter Club logo

regen-js's Introduction

Actions Status GitHub License



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

# 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

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.

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. npm version
@regen-network/demo-app 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.