{"id":13766472,"url":"https://github.com/ConsenSys/quorum-dev-quickstart","last_synced_at":"2025-05-10T22:31:11.776Z","repository":{"id":36986205,"uuid":"281021656","full_name":"Consensys/quorum-dev-quickstart","owner":"Consensys","description":"The Quorum Developer Quickstart utility can be used to rapidly generate local Quorum blockchain networks for development and demo purposes using Besu and GoQuorum","archived":false,"fork":false,"pushed_at":"2024-07-24T00:50:37.000Z","size":11197,"stargazers_count":140,"open_issues_count":12,"forks_count":98,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-04-28T09:32:45.799Z","etag":null,"topics":["blockchain","docker","ethereum","hyperledger-besu","quorum"],"latest_commit_sha":null,"homepage":"","language":"Solidity","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Consensys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-20T05:25:08.000Z","updated_at":"2025-04-27T10:41:34.000Z","dependencies_parsed_at":"2024-06-21T05:43:14.142Z","dependency_job_id":"0e33ffbe-e2ac-4f1b-b3f0-9ee87270c19a","html_url":"https://github.com/Consensys/quorum-dev-quickstart","commit_stats":{"total_commits":302,"total_committers":39,"mean_commits":7.743589743589744,"dds":0.5894039735099338,"last_synced_commit":"b7a3c6425456c755fc84bb3799bf43b6a7e19343"},"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Consensys%2Fquorum-dev-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Consensys%2Fquorum-dev-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Consensys%2Fquorum-dev-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Consensys%2Fquorum-dev-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Consensys","download_url":"https://codeload.github.com/Consensys/quorum-dev-quickstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253209296,"owners_count":21871630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","docker","ethereum","hyperledger-besu","quorum"],"created_at":"2024-08-03T16:00:55.762Z","updated_at":"2025-05-10T22:31:10.876Z","avatar_url":"https://github.com/Consensys.png","language":"Solidity","funding_links":[],"categories":["Deployment"],"sub_categories":["Sandbox"],"readme":"# Quorum Dev Quickstart\n\n\n## Table of Contents\n1. [Prerequisites](#prerequisites)\n2. [Usage](#usage)\n\n## Prerequisites\n\nTo run these tutorials, you must have the following installed:\n\n- [Docker and Docker-compose](https://docs.docker.com/compose/install/) v2 or higher\n\n| ⚠️ **Note**: If on MacOS or Windows, please ensure that you allow docker to use upto 4G of memory or 6G if running Privacy examples under the _Resources_ section. The [Docker for Mac](https://docs.docker.com/docker-for-mac/) and [Docker Desktop](https://docs.docker.com/docker-for-windows/) sites have details on how to do this at the \"Resources\" heading       |\n| ---                                                                                                                                                                                                                                                                                                                                                                                |\n\n\n| ⚠️ **Note**: This has only been tested on Windows 10 Build 19045, WSL2 and Docker Desktop                                                                                                                                                 |\n| ---                                                                                                                                                                                                                                                                                                                                                                                |\n\n- On Windows, please use WSL2 kernels 5.15x or higher\n- You can use either Docker Desktop or docker-engine (with the compose plugin) within the WSL2 environment\n- [Nodejs](https://nodejs.org/en/download/) or [Yarn](https://yarnpkg.com/cli/node)\n\n\n## Usage \n\nCreate the docker compose file and artifacts with \n\n```\n$\u003e npx quorum-dev-quickstart\n              ___\n             / _ \\   _   _    ___    _ __   _   _   _ __ ___\n            | | | | | | | |  / _ \\  | '__| | | | | | '_ ' _ \\\n            | |_| | | |_| | | (_) | | |    | |_| | | | | | | |\n             \\__\\_\\  \\__,_|  \\___/  |_|     \\__,_| |_| |_| |_|\n     \n        ____                          _\n       |  _ \\    ___  __   __   ___  | |   ___    _ __     ___   _ __\n       | | | |  / _ \\ \\ \\ / /  / _ \\ | |  / _ \\  | '_ \\   / _ \\ | '__|\n       | |_| | |  __/  \\ V /  |  __/ | | | (_) | | |_) | |  __/ | |\n       |____/   \\___|   \\_/    \\___| |_|  \\___/  | .__/   \\___| |_|\n                                                 |_|\n       ___            _          _            _                    _\n      / _ \\   _   _  (_)   ___  | | __  ___  | |_    __ _   _ __  | |_\n     | | | | | | | | | |  / __| | |/ / / __| | __|  / _' | | '__| | __|\n     | |_| | | |_| | | | | (__  |   \u003c  \\__ \\ | |_  | (_| | | |    | |_ \n      \\__\\_\\  \\__,_| |_|  \\___| |_|\\_\\ |___/  \\__|  \\__,_| |_|     \\__|\n\n\nWelcome to the Quorum Developer Quickstart utility. This tool can be used\nto rapidly generate local Quorum blockchain networks for development purposes\nusing tools like GoQuorum, Besu, and Tessera.\n\nTo get started, be sure that you have both Docker and Docker Compose\ninstalled, then answer the following questions.\n\nWhich Ethereum client would you like to run? Default: [1]\n\t1. Hyperledger Besu\n\t2. GoQuorum\n  ...\n  Do you wish to enable support for private transactions? [Y/n]\n  ...\n  Do you wish to enable support for logging with Splunk or ELK (Elasticsearch, Logstash \u0026 Kibana)? Default: [1]\n\t1. None\n\t2. Splunk\n\t3. ELK\n...\nWhere should we create the config files for this network? Please\nchoose either an empty directory, or a path to a new directory that does\nnot yet exist. Default: ./quorum-test-network\n```\n\nThis prompts you to pick a quorum variant, whether you would like to try Privacy and the location for the artifacts. By \ndefault artifact files are stored at `./quorum-test-network`, change directory to the artifacts folder: \n\n```\n$\u003e cd quorum-test-network\n``` \n\n\nAlternatively, you can use cli options and skip the prompt above like so:\n\n```\nnpx quorum-dev-quickstart --clientType besu --outputPath ./quorum-test-network --monitoring default --privacy true\n```\n\nThe arguments ```--privacy``` and ```--clientType``` are required, the others contain defaults if left blank.\n\n**To start services and the network:**\n\nFollow the README.md file of select artifact:\n1. [Hyperledger Besu](./files/besu/README.md)\n2. [GoQuorum](./files/goquorum/README.md)\n\n## Troubleshooting\n\n### Besu only - `java.io.IOException: Permission denied` for volumes\n\nThe `besu` containers use user `besu` mapped to user:group 1000. On your local machine, if your userid is not 1000, you will see this error. To fix this either run as user 1000 or map\nthe container's user 1000 to your local user id so permissions will work like so in the compose file\n\n```\nimage: some:img\nuser: $(id -u):$(id -g)\n```\n\n### `quorumengineering/tessera` can't be found on Mac OS and no match for platform \n\nOften, when trying to use tessera with `quorum-dev-quickstart` on Mac OS, you may encounter a message stating that the `tessera` image cannot be found and does not match the platform. \n\n```\nfailed to solve: quorumengineering/tessera:23.4.0: no match for platform in manifest sha256:fb436c0ac56b79ca7cda27b92a3f81273de77d1c5b813aba0183333ca483053e: not found\n```\n\nIn this case, you can modify the `FROM` statement in the `Dockerfile` located at `quorum-test-network/config/tessera` as follows.\n\n```\nFROM --platform=linux/amd64 quorumengineering/tessera:${TESSERA_VERSION}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FConsenSys%2Fquorum-dev-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FConsenSys%2Fquorum-dev-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FConsenSys%2Fquorum-dev-quickstart/lists"}