/jade-desktop

👤 User Interface for Jade Service Runner 👟

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Jade Service Runner UI

Jade Service Runner UI

A UI app for managing JSON-RPC services.
Report Bug · Request Feature

Table of Contents

About The Project

Jade Service Runner UI is an app that bundles Jade Service Runner and its interface into an easy to use application for users to install, manage, and discover locally run services.

Better dApp Development

Service Runner improves the dApp development cycle, by reducing the number of steps required for running services that are local to the user, in addition to associated with relying on locally running JSON-RPC services. To do this effectively, Jade Service Runner supports the following:

  • Allows dApp developers to specify what services they'd like to use
  • Provides defaults for the services to run
  • Provides users with an easy installation path
  • Provides reliable discovery of pre-existing services run by the service runner
  • Provides OpenRPC interface to the Service Runnner functionality, as well as the underlying services
  • Allows dApp developers the ability to retrieve reliable JSON-RPC connection information from the service
  • Provides typed interfaces to develop applications against

Getting Started

Installation

Install via binary

Download and install the latest binary for Windows, MacOS, or Linux here.

Usage

Development

  • npm install
  • npm start
  • npm run electron

Extended services

A way to extend services, see here for more info.

jade-service-runner-ui.app/Contents/MacOS/jade-service-runner-ui -c my-extended-config.json

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

License

Apache License 2.0

Resources