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

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

Last synced: 12 months ago
JSON representation

Hyperledger FireFly Sandbox

• Host: GitHub
• URL: https://github.com/hyperledger/firefly-sandbox
• Owner: hyperledger
• License: apache-2.0
• Created: 2022-03-31T17:20:24.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-10T01:35:41.000Z (about 1 year ago)
• Last Synced: 2025-05-01T09:05:25.914Z (12 months ago)
• Language: TypeScript
• Homepage:
• Size: 3.05 MB
• Stars: 13
• Watchers: 12
• Forks: 11
• Open Issues: 9
• 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 Sandbox

![version-ui](https://img.shields.io/github/package-json/v/hyperledger/firefly-sandbox?color=orange&filename=ui%2Fpackage.json&label=firefly-sandbox-ui)

![version-server](https://img.shields.io/github/package-json/v/hyperledger/firefly-sandbox?color=orange&filename=server%2Fpackage.json&label=firefly-sandbox-server)

[![FireFly 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 an API exerciser and prototyping tool for applications that communicate with FireFly.

### Dashboard

![Sandbox Dashboard](./ui/src/images/dashboard.png)

## Running with CLI

As of v0.0.47 of the [firefly-cli](https://github.com/hyperledger/firefly-cli), one instance

of the sandbox will be started by default for each member of your local FireFly network.

Simply initialize a new stack with the default parameters, and you'll be able to explore and

exercise it using the sandbox.

## Running manually

To run the application manually, start the server and the UI:

```

cd server

npm install

npm run start:dev

```

```

cd ui

npm install

npm start

```

Note: If your Firefly instance is not exposed on port 5000 locally or running remotely, set the env FF_ENDPOINT to the location of your instance.

## Git repositories

There are multiple Git repos making up the Hyperledger FireFly project. Some others

that may be helpful to reference:

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

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

- FireFly Node.js SDK - https://github.com/hyperledger/firefly-sdk-nodejs

## Contributing

Interested in contributing to the community?

Check out our [Contributor Guide](https://hyperledger.github.io/firefly/latest/contributors/contributors.html), 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.