From 05b24648a7b43ec6e1857eb5fa764f39ae667fd3 Mon Sep 17 00:00:00 2001 From: Emiel Sebastiaan <14069142+emielvanderhoek@users.noreply.github.com> Date: Tue, 5 May 2020 17:35:14 +0200 Subject: [PATCH] Fix readme --- README.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index bc8c33df..45b8a69f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,33 @@ # Polkascan Open-Source Polkascan Open-Source Application -## Run application for a development network +## Quick deployment +### Step 1: Clone repository: +```bash +git clone https://github.com/polkascan/polkascan-os.git +``` +### Step 2: Change directory: +```bash +cd polkascan-os +``` +### Step 3: Check available releases: +```bash +git tag +``` +### Step 4: Checkout latest releases: +```bash +git checkout v0.x.x +``` +### Step 5: Make sure to also clone submodules within the cloned directory: +```bash +git submodule update --init --recursive +``` +### Step 6: Then build the other docker containers +```bash +docker-compose -p kusama -f docker-compose.kusama-quick.yml up --build +``` + +## Full deployment The following steps will run a full Polkascan-stack that harvests blocks from a new local network. ### Step 1: Clone repository: @@ -26,27 +52,16 @@ git submodule update --init --recursive ``` ### Step 6: During the first run let MySQL initialize (wait for about a minute) ```bash -docker-compose -p dev -f docker-compose.yml up -d mysql +docker-compose -p kusama -f docker-compose.kusama-full.yml up -d mysql ``` ### Step 7: Then build the other docker containers ```bash -docker-compose -p dev -f docker-compose.yml up --build -``` - -## Run application for existing public networks -For existing public networks use the following commands in step 6 & 7 respectively: - -### Kusama -```bash -docker-compose -p kusama -f docker-compose.kusama.yml up -d mysql -docker-compose -p kusama -f docker-compose.kusama.yml up --build +docker-compose -p kusama -f docker-compose.kusama-full.yml up --build ``` ## Links to applications - * Polkascan Explorer GUI: http://127.0.0.1:8080 * Harvester Task Monitor: http://127.0.0.1:5555 -* Harvester Status: http://127.0.0.1:8080/harvester/admin * Polkadot JS Apps: http://127.0.0.1:8081 ## Cleanup Docker