Skip to content
This repository was archived by the owner on Feb 8, 2023. It is now read-only.

Commit f80dfe3

Browse files
Added Quorum Dev Quickstart (#61)
* updating submodule to latest Signed-off-by: Madeline <[email protected]> * Added Quorum dev quickstart Signed-off-by: Madeline <[email protected]> * newline Signed-off-by: Madeline <[email protected]>
1 parent fa5dc7d commit f80dfe3

File tree

4 files changed

+39
-1
lines changed

4 files changed

+39
-1
lines changed

common

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Quorum Developer Quickstart
3+
description: Rapidly generate local Quorum blockchain networks.
4+
---
5+
6+
# Quorum Developer Quickstart
7+
8+
## Prerequisites
9+
10+
- [Docker and Docker-compose](https://docs.docker.com/compose/install/)
11+
- [Nodejs](https://nodejs.org/en/download/)
12+
- On Windows:
13+
- Windows Subsystem for Linux 2
14+
- Docker desktop configured to use the WSL2-based engine.
15+
16+
!!! important
17+
Ensure you allow Docker up to 4G of memory or 6G if running the privacy examples.
18+
Refer to the _Resources_ section in [Docker for Mac](https://docs.docker.com/docker-for-mac/) and
19+
[Docker Desktop](https://docs.docker.com/docker-for-windows/) for details.
20+
21+
## Usage
22+
23+
To create the docker-compose file and artifacts, run:
24+
25+
```bash
26+
npx quorum-dev-quickstart
27+
```
28+
29+
Follow the prompts displayed.
30+
31+
When installation is complete, refer to `README.md` in the installation directory for more information
32+
on your test network.

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ The primary application of Orion is as the private transaction manager for [Hype
1414
Yes. [ConsenSys Quorum](https://consensys.net/quorum/developers) is the complete open source blockchain
1515
layer with enterprise support available from [ConsenSys](https://consensys.net/quorum/contact-us).
1616

17+
## New to ConsenSys Quorum?
18+
19+
Get started with the [Quorum Developer Quickstart](Tutorials/Quorum-Dev-Quickstart.md). Use the quickstart
20+
to rapidly generate local Quorum blockchain networks.
21+
1722
## What can you do with Orion?
1823

1924
Orion:

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ nav:
6363
- Using PostgreSQL: Tutorials/Using-PostgreSQL.md
6464
- TLS: Tutorials/TLS.md
6565
- Generating Orion certificates: Tutorials/Generating-Certificates.md
66+
- Quorum Developer Quickstart: Tutorials/Quorum-Dev-Quickstart.md
6667
- Concepts:
6768
- Privacy groups: Concepts/Privacy-Groups.md
6869
- Disaster recovery: Concepts/Disaster-Recovery.md

0 commit comments

Comments
 (0)