Get started with Quorum Developer Quickstart
- Node.js and NPM version 14 or higher
- Docker and Docker-compose
- Truffle development framework
Run Quorum Developer Quickstart
To run the quickstart without installation, use
You can also install the quickstart globally with
npm install -g quorum-dev-quickstart
# Once the global module is installed, run:
Many npm installations don't have permission to install global modules and will throw an EACCES error. npm has a recommended solution.
You can provide these flags when running
|Flag||Required to skip prompt||Description|
|`--privacy=<true||false>`||Yes||Enables or disables private transaction support.|
|`--orchestrate=<true||false>`||No||Enables support for ConsenSys Orchestrate.|
|No||Path to output artifacts.|
Interacting with the network
To explore the features of GoQuorum, such as permissioning and privacy, follow the Quorum Developer Quickstart tutorial. The tutorial also has information on smart contracts, dapps, wallets, and monitoring the network.
The quickstart provides the option to deploy monitoring tools alongside your network. You can use:
- Prometheus and Grafana to collect and visualize metrics.
- Cakeshop to explore the chain, work with contracts, and manage peers and permissions.
- Quorum Reporting to inspect contracts.
- Grafana Loki to manage logs.
- Elastic Stack to manage logs.
- Splunk to manage logs.
Clone the repo to your local machine:
git clone https://github.com/ConsenSys/quorum-dev-quickstart.git
Change into the quickstart directory:
Install all dependencies:
Build changes to any files in the
srcdirectory and output to a build directory:
npm run build
Run the updated quickstart:
npm run start
Alternatively, you can run
Quorum Dev Quickstart is open source, and we invite you to contribute enhancements. You will be required to complete a Contributor License Agreement (CLA) before we are able to merge. If you have any questions about the contribution process, you can get them answered on the GoQuorum community support.
Stuck on a step? Please join the GoQuorum community support.