From 3acd1a64e6a5b667296cfcac51c3a969a10ab90e Mon Sep 17 00:00:00 2001 From: MorphTail <47940274+m0rphtail@users.noreply.github.com> Date: Wed, 29 Apr 2020 17:20:24 +0530 Subject: [PATCH 1/4] Update README.md Making the setup process easier and better --- README.md | 58 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 37 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 2d4c21c766a..6e2c4015037 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # Bitcore -![Circle CI](https://circleci.com/gh/bitpay/bitcore/tree/master.svg?style=shield) **Infrastructure to build Bitcoin and blockchain-based applications for the next generation of financial technology.** @@ -9,6 +8,7 @@ - Trusted P2P Peer - MongoDB Server >= v3.4 +- Docker - make g++ gcc ### Checkout the repo @@ -16,13 +16,48 @@ ```sh git clone git@github.com:bitpay/bitcore.git +cd bitcore git checkout master npm install ``` ## Setup Guide -### 1. Setup Bitcore config +### 1. Setup Docker + +Start Docker by running + +```sh +sudo dockerd +``` + +```sh +sudo docker-compose -f docker-compose.test.yml up +``` + +### 2. Setup Bitcore Node Config + +```sh +sudo docker ps + +# Get IP Addresses of the Dockers + +sudo docker inspect deviceID | grep IPAddress + +# Enter your docker device ID in place of deviceID + +# Replace the hostname with that respective IP address of your docker in Bitcore-test.config.json
+ +mv Bitcore-test.config.json Bitcore.config.json +``` + +### 3. Start Bitcore + +```sh +npm run node +``` + +## Example Config files
Example bitcore.config.json @@ -104,8 +139,6 @@ npm install
-### 2. Setup Bitcoin Node -
Example Bitcoin Mainnet Config @@ -133,23 +166,6 @@ rpcpassword=password
-### 3. Run Bitcoin node - -
-Example Starting a Bitcoin Node - -```sh -# Path to your bitcoin application and path to the config above -/Applications/Bitcoin-Qt.app/Contents/MacOS/Bitcoin-Qt -datadir=/Users/username/blockchains/bitcoin-core/networks/mainnet/ -``` - -
- -### 4. Start Bitcore - -```sh -npm run node -``` ## Applications From b901da88ecef35b585b33c05bf259ba20cb7b4e3 Mon Sep 17 00:00:00 2001 From: MorphTail <47940274+m0rphtail@users.noreply.github.com> Date: Wed, 29 Apr 2020 17:23:00 +0530 Subject: [PATCH 2/4] Update README.md Making the setup process beginner friendly. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e2c4015037..6751b8b6875 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ sudo docker inspect deviceID | grep IPAddress # Enter your docker device ID in place of deviceID -# Replace the hostname with that respective IP address of your docker in Bitcore-test.config.json
+# Replace the hostname with that respective IP address of your docker in Bitcore-test.config.json mv Bitcore-test.config.json Bitcore.config.json ``` From 36497ac5c160cbd5b1b3cb9e2af81ec7255460b9 Mon Sep 17 00:00:00 2001 From: MorphTail <47940274+m0rphtail@users.noreply.github.com> Date: Wed, 29 Apr 2020 19:48:01 +0530 Subject: [PATCH 3/4] Update README.md remove sudo --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6751b8b6875..79de44a958d 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ - Trusted P2P Peer - MongoDB Server >= v3.4 - Docker +- nodejs >= 10 - make g++ gcc ### Checkout the repo @@ -28,21 +29,21 @@ npm install Start Docker by running ```sh -sudo dockerd +dockerd ``` ```sh -sudo docker-compose -f docker-compose.test.yml up +docker-compose -f docker-compose.test.yml up ``` ### 2. Setup Bitcore Node Config ```sh -sudo docker ps +docker ps # Get IP Addresses of the Dockers -sudo docker inspect deviceID | grep IPAddress +docker inspect deviceID | grep IPAddress # Enter your docker device ID in place of deviceID From 1d0c35b790d5da74ed1d0f53d295b1550a9abdbf Mon Sep 17 00:00:00 2001 From: MorphTail <47940274+m0rphtail@users.noreply.github.com> Date: Wed, 29 Apr 2020 23:23:18 +0530 Subject: [PATCH 4/4] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 79de44a958d..e72daabc6a5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Bitcore +![Circle CI](https://circleci.com/gh/bitpay/bitcore/tree/master.svg?style=shield) + **Infrastructure to build Bitcoin and blockchain-based applications for the next generation of financial technology.** ## Getting Started