# firefly-sandbox

**Repository Path**: hyperledger/firefly-sandbox

## Basic Information

- **Project Name**: firefly-sandbox
- **Description**: Hyperledger FireFly Sandbox
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-14
- **Last Updated**: 2025-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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.