diff --git a/README.md b/README.md index 2d4c21c766a..e72daabc6a5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # 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 +10,8 @@ - Trusted P2P Peer - MongoDB Server >= v3.4 +- Docker +- nodejs >= 10 - make g++ gcc ### Checkout the repo @@ -16,13 +19,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 +dockerd +``` + +```sh +docker-compose -f docker-compose.test.yml up +``` + +### 2. Setup Bitcore Node Config + +```sh +docker ps + +# Get IP Addresses of the Dockers + +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 +142,6 @@ npm install
-### 2. Setup Bitcoin Node -
Example Bitcoin Mainnet Config @@ -133,23 +169,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