docs: Add template for environment variables used in demo scripts (#208)

Author: bennycode

.env.defaults

@@ -0,0 +1,19 @@
+# Instructions:
+# 1) Copy this file to the root of this repository and name it ".env"
+# 2) Enter your API keys in the ".env" file
+# 3) Now your API keys can be used by "init-client.ts" from the "src/demo" directory
+# 4) You can test it by running: npx ts-node ./src/demo/dump-candles.ts
+# 5) Alternatively, you can run: yarn demo:candles
+
+# Set to "false" if you want to use your production API key
+USE_SANDBOX="true"
+
+# Your sandbox API key from: https://public.sandbox.pro.coinbase.com/profile/api
+COINBASE_PRO_SANDBOX_API_KEY=""
+COINBASE_PRO_SANDBOX_API_SECRET=""
+COINBASE_PRO_SANDBOX_PASSPHRASE=""
+
+# Your production API key from: https://pro.coinbase.com/profile/api
+COINBASE_PRO_API_KEY=""
+COINBASE_PRO_API_SECRET=""
+COINBASE_PRO_PASSPHRASE=""

README.md

@@ -87,12 +87,14 @@ If you want to listen to WebSocket messages, have a look at these demo scripts:
 
 ### Demos
 
-All [demo scripts][3] are executable from the root directory. If you want to use specific credentials with a demo script, simply add a `.env` file to the root of this package to [modify environment variables](https://github.com/motdotla/dotenv#usage) used in [init-client.ts](https://github.com/bennyn/coinbase-pro-node/blob/master/src/demo/init-client.ts).
+All [demo scripts][3] are executable from the root directory. If you want to use specific credentials with a demo script, simply add a `.env` file to the root of this package to [modify environment variables](https://github.com/motdotla/dotenv/tree/v8.2.0#usage) used in [init-client.ts](https://github.com/bennyn/coinbase-pro-node/blob/master/src/demo/init-client.ts).
 
 ```bash
 npx ts-node ./src/demo/dump-candles.ts
 ```
 
+**Tip:** There is a [.env.defaults](https://github.com/bennyn/coinbase-pro-node/blob/master/.env.defaults) file which serves as a template. Just remove its `.defaults` extension and enter your credentials to get started. Do not commit this file (or your credentials) to any repository!
+
 ### Real-world examples
 
 Checkout [GitHub's dependency graph][6] to see who uses "coinbase-pro-node" in production. There are also [npm packages][7] depending on "coinbase-pro-node".

package.json

@@ -19,7 +19,7 @@
     "@typescript-eslint/eslint-plugin": "3.6.0",
     "@typescript-eslint/parser": "3.6.0",
     "cross-env": "7.0.2",
-    "dotenv": "8.2.0",
+    "dotenv-defaults": "2.0.0",
     "eslint": "7.4.0",
     "eslint-config-prettier": "6.11.0",
     "eslint-plugin-prettier": "3.1.4",
@@ -77,6 +77,7 @@
     "changelog:commit": "git add CHANGELOG.md && git commit -m \"docs: Updated changelog\"",
     "clean": "rimraf .nyc_output coverage dist",
     "demo": "cross-env NODE_DEBUG=coinbase-pro-node* ts-node src/demo/rest-get-candles.ts",
+    "demo:candles": "cross-env NODE_DEBUG=coinbase-pro-node* ts-node src/demo/dump-candles.ts",
     "demo:ws": "cross-env NODE_DEBUG=coinbase-pro-node* ts-node src/demo/websocket-ticker.ts",
     "docs": "yarn docs:build && yarn docs:start",
     "docs:build": "yarn typedoc",

src/demo/init-client.ts

@@ -1,6 +1,6 @@
 import {CoinbasePro} from '..';
 
-require('dotenv').config();
+import 'dotenv-defaults/config';
 
 export function initClient(): CoinbasePro {
   if (process.env.USE_SANDBOX === 'true') {

yarn.lock

@@ -700,7 +700,14 @@ doctrine@^3.0.0:
   dependencies:
     esutils "^2.0.2"
 
-dotenv@8.2.0:
+dotenv-defaults@2.0.0:
+  version "2.0.0"
+  resolved "https://registry.npmjs.org/dotenv-defaults/-/dotenv-defaults-2.0.0.tgz#f48577d885c7755d2a4ce1f7f3706552c0cb367e"
+  integrity sha512-8X8gQoM+BH0L/v+GwgpeNwrthbG2uTDVr3vkbedQPLrIalZE0vxB9LbuD+7echbiP7fAY3tE+pZI11R1DtlUNg==
+  dependencies:
+    dotenv "^8.2.0"
+
+dotenv@^8.2.0:
   version "8.2.0"
   resolved "https://registry.npmjs.org/dotenv/-/dotenv-8.2.0.tgz#97e619259ada750eea3e4ea3e26bceea5424b16a"
   integrity sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw==