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]>
Consensys · Nov 1, 2020 · f80dfe3 · f80dfe3
1 parent fa5dc7d
commit f80dfe3
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 1 deletion.
diff --git a/common b/common
diff --git a/docs/Tutorials/Quorum-Dev-Quickstart.md b/docs/Tutorials/Quorum-Dev-Quickstart.md
@@ -0,0 +1,32 @@
+---
+title: Quorum Developer Quickstart
+description: Rapidly generate local Quorum blockchain networks.
+---
+
+# Quorum Developer Quickstart
+
+## Prerequisites
+
+- [Docker and Docker-compose](https://docs.docker.com/compose/install/)
+- [Nodejs](https://nodejs.org/en/download/)
+- On Windows:
+    - Windows Subsystem for Linux 2
+    - Docker desktop configured to use the WSL2-based engine.
+
+!!! important
+    Ensure you allow Docker up to 4G of memory or 6G if running the privacy examples.
+    Refer to the _Resources_ section in [Docker for Mac](https://docs.docker.com/docker-for-mac/) and
+    [Docker Desktop](https://docs.docker.com/docker-for-windows/) for details.
+
+## Usage
+
+To create the docker-compose file and artifacts, run:
+
+```bash
+npx quorum-dev-quickstart
+```
+
+Follow the prompts displayed.
+
+When installation is complete, refer to `README.md` in the installation directory for more information
+on your test network.
diff --git a/docs/index.md b/docs/index.md
@@ -14,6 +14,11 @@ The primary application of Orion is as the private transaction manager for [Hype
 Yes. [ConsenSys Quorum](https://consensys.net/quorum/developers) is the complete open source blockchain
 layer with enterprise support available from [ConsenSys](https://consensys.net/quorum/contact-us).
 
+## New to ConsenSys Quorum?
+
+Get started with the [Quorum Developer Quickstart](Tutorials/Quorum-Dev-Quickstart.md). Use the quickstart
+to rapidly generate local Quorum blockchain networks.
+
 ## What can you do with Orion?
 
 Orion:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -63,6 +63,7 @@ nav:
         - Using PostgreSQL: Tutorials/Using-PostgreSQL.md
         - TLS: Tutorials/TLS.md
         - Generating Orion certificates: Tutorials/Generating-Certificates.md
+        - Quorum Developer Quickstart: Tutorials/Quorum-Dev-Quickstart.md
     - Concepts:
         - Privacy groups: Concepts/Privacy-Groups.md
         - Disaster recovery: Concepts/Disaster-Recovery.md