Last update: March 10, 2022

Get started with Quorum Developer Quickstart¶

The Quorum Developer Quickstart is a command line tool that allows users to set up a development GoQuorum network on their local machine in less than two minutes. The quickstart is written in Javascript and designed to be run as a global npm module from the command line.

Prerequisites¶

Node.js and NPM version 14 or higher
Docker and Docker-compose
Truffle development framework
curl command line
MetaMask

Run Quorum Developer Quickstart¶

To run the quickstart without installation, use npx:

npx quorum-dev-quickstart

You can also install the quickstart globally with npm:

npm install -g quorum-dev-quickstart

# Once the global module is installed, run:
quorum-dev-quickstart

Note

Many npm installations don’t have permission to install global modules and will throw an EACCES error. npm has a recommended solution.

Options¶

You can provide these flags when running quorum-dev-quickstart:

Flag	Required to skip prompt	Description
`--clientType=<STRING>`	Yes	Use `quorum` for GoQuorum.
`--privacy=<true\|false>`	Yes	Enables or disables private transaction support.
`--orchestrate=<true\|false>`	No	Enables support for ConsenSys Orchestrate.
`--monitoring=<STRING>`	No	Use `default` for Prometheus, Grafana,`elk` to add ELK; `splunk` to add Splunk.
`--outputPath=<PATH>`	No	Path to output artifacts.
`-h`, `--help`	No	Show help.

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.

Tools¶

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.
Elastic Stack to manage logs.
Splunk to manage logs.

Developing¶

Clone the repo to your local machine:

git clone https://github.com/ConsenSys/quorum-dev-quickstart.git

Change into the quickstart directory:
```
cd quorum-dev-quickstart
```
Install all dependencies:
```
npm install
```
Build changes to any files in the src directory and output to a build directory:
```
npm run build
```
Run the updated quickstart:
```
npm run start
```
Alternatively, you can run node build/index.js.

Contributing¶

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.

Getting help¶

Stuck on a step? Please join the GoQuorum community support.