https://github.com/hyperledger/firefly-ui

FireFly UI
https://github.com/hyperledger/firefly-ui

Last synced: 12 months ago
JSON representation

FireFly UI

• Host: GitHub
• URL: https://github.com/hyperledger/firefly-ui
• Owner: hyperledger
• License: apache-2.0
• Created: 2021-05-03T19:55:23.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-05-07T07:51:41.000Z (12 months ago)
• Last Synced: 2025-05-11T21:15:08.451Z (12 months ago)
• Language: TypeScript
• Homepage:
• Size: 6.19 MB
• Stars: 35
• Watchers: 14
• Forks: 29
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# FireFly UI

![version](https://img.shields.io/github/package-json/v/hyperledger/firefly-ui?label=firefly-ui)

[![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#release-candidate)

[![FireFy Documentation](https://img.shields.io/static/v1?label=FireFly&message=documentation&color=informational)](https://hyperledger.github.io/firefly//)

![Hyperledger FireFly](./images/hyperledger_firefly_logo.png)

This is the User Interface for FireFly. It allows yo to easily see everything that is going on in your FireFly system.

### Dashboard

![FireFly Explorer Dashboard](./images/firefly_explorer.png)

### Events Timeline

![FireFly Explorer Timeline](./images/firefly_timeline.png)

### Token Pools

![FireFly Token Pool](./images/firefly_token_pool.png)

## Setup

To run the application, you will require a 2-party FireFly system running

locally on ports 5000 & 5001. The easiest way to set this up is with the

[FireFly CLI](https://github.com/hyperledger/firefly-cli):

```

ff init myFireFly 2

ff start myFireFly

```

## Running

Once the FireFly stack is ready, you can view it a http://localhost:5000/ui

## Getting started locally

To start developing the UI locally, make sure to have a 2-party FireFly system running locally.

```bash

git clone https://github.com/hyperledger/firefly-ui

cd firefly-ui

npm i

npm run start

```

## Learn more about Hyperledger FireFly Architecture

- [YouTube Channel](https://www.youtube.com/playlist?list=PL0MZ85B_96CFVEdBNsHRoX_f15AJacZJD)

  - Check out the architecture series

- [Architecture reference documentation](https://hyperledger.github.io/firefly/latest/architecture/node_component_architecture)

  - Join the discussion [on Discord](http://discord.gg/hyperledger)

## Git repositories

There are multiple Git repos making up the Hyperledger FireFly project, and this

list is likely to grow as additional pluggable extensions come online in the community:

- Command Line Interface (CLI) - https://github.com/hyperledger/firefly-cli

- Core - https://github.com/hyperledger/firefly

- FireFly SDK - https://github.com/kaleido-io/firefly-sdk-nodejs

- FireFly Sandbox (this repo) - https://github.com/kaleido-io/firefly-sandbox

- HTTPS Data Exchange - https://github.com/hyperledger/firefly-dataexchange-https

- Hyperledger Fabric connector - https://github.com/hyperledger/firefly-fabconnect

- Ethereum (Hyperledger Besu / Quorum) connector - https://github.com/hyperledger/firefly-ethconnect

- Corda connector: https://github.com/hyperledger/firefly-cordaconnect - contributed from Kaleido generation 1 - porting to generation 2

- FireFly Sandbox - https://github.com/hyperledger/firefly-sandbox

- Firefly Performance CLI (https://github.com/hyperledger/firefly-perf-cli)

## Contributing

Interested in contributing to the community?

Check out our [Contributor Guide](https://hyperledger.github.io/firefly/latest/contributors/), and welcome!

Please adhere to this project's [Code of Conduct](CODE_OF_CONDUCT.md).

## License

Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file.