From 974ade0e8229141ebd5c8b662240f134409e5d81 Mon Sep 17 00:00:00 2001 From: kyle-mcintosh Date: Fri, 31 Aug 2018 12:10:02 +0200 Subject: [PATCH 1/2] added installation notes in the readmen file. --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9d705e..a4a0387 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# web-sample-2 \ No newline at end of file +# Web Sample App + +## Setup + +You will need a `APPID` in order to run the sample application. + +To obtain a key, You will have to register at : https://developer.blockv.io/request-access to request a development key. + +Once you have obtained a key, Simply open the `src/Common/Blockv.js` file and replace `{{APPID}}` with your key. + +## Installation + +Download the repo, Make sure you have Node.js & npm installed on your machine. + +### How do I know if I have node isntalled? + +Open your terminal or command promt (windows) + +Type in node -v + +If your terminal responds with a version - You should be ready to proceed to installation + +If your terminal responds with an error, You can install node.js from here: https://nodejs.org/en/ + +Once you have completed the Node.js and NPM install, follow the instructions below: + + +In your terminal, navigate to the folder where the repo has been downloaded to and type in the following command: + + npm install + +Once installation is complete, simply run the application in the same terminal window by typing in: + + npm run + +Your application should be up and running and ready to test. From 715aba0ce240ae32b40dc0791a1bcf1813ae73cf Mon Sep 17 00:00:00 2001 From: kyle-mcintosh Date: Fri, 31 Aug 2018 13:52:35 +0200 Subject: [PATCH 2/2] fixed uppercase after commas --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a4a0387..9cd1f8d 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ You will need a `APPID` in order to run the sample application. -To obtain a key, You will have to register at : https://developer.blockv.io/request-access to request a development key. +To obtain a key, you will have to register at : https://developer.blockv.io/request-access to request a development key. -Once you have obtained a key, Simply open the `src/Common/Blockv.js` file and replace `{{APPID}}` with your key. +Once you have obtained a key, simply open the `src/Common/Blockv.js` file and replace `{{APPID}}` with your key. ## Installation -Download the repo, Make sure you have Node.js & npm installed on your machine. +Download the repo, make sure you have Node.js & npm installed on your machine. ### How do I know if I have node isntalled? @@ -20,7 +20,7 @@ Type in node -v If your terminal responds with a version - You should be ready to proceed to installation -If your terminal responds with an error, You can install node.js from here: https://nodejs.org/en/ +If your terminal responds with an error, you can install node.js from here: https://nodejs.org/en/ Once you have completed the Node.js and NPM install, follow the instructions below: