Quorum Wizard is a command line tool that allow users to set up a development Quorum network on their local machine in less than 2 minutes.
quorum-wizard is written in Javascript and designed to be installed as a global NPM module and run from the command line. Make sure you have Node.js installed, which includes the npm package manager.
Using npm:
npm install -g quorum-wizardUsing Yarn:
yarn global add quorum-wizardOnce the global module is installed, just run:
quorum-wizardThe wizard will then walk you through setting up a network, either using our quickstart settings (a simple 3-node Quorum network using Raft consensus), or customizing the options to fit your needs.
You can also provide these flags when running quorum-wizard:
-
-q,--quickstartcreate 3 node raft network with tessera and cakeshop (no user-input required) -
-v,--verboseTurn on additional logs for debugging -
--versionShow version number -
-h,--helpShow help
Note: npx is also way to run npm modules without the need to actually install the module. Due to quorum-wizard needing to download and cache the quorum binaries during network setup, using npx quorum-wizard will not work at this time.
To explore the features of Quorum and deploy a private contract, follow the instructions on Interacting with the Network
Clone this repo to your local machine.
yarn install to get all the dependencies.
yarn test:watch to automatically run tests on changes
yarn start to automatically build on changes to any files in the src directory
yarn link to use your development build when you run the global npm command
quorum-wizard to run (alternatively, you can run node build/index.js)
Quorum Wizard is built on open source and we invite you to contribute enhancements. Upon review 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, please feel free to send an email to info@goquorum.com.