From 4953b40a4213bcd98e0a2dc1df0238d211d83137 Mon Sep 17 00:00:00 2001 From: fmtabbara Date: Sat, 20 Nov 2021 21:12:06 +0000 Subject: [PATCH] add readme file --- testnet-faucet/.env.sample | 6 ++++++ testnet-faucet/README.md | 17 +++++++++++++++++ testnet-faucet/package.json | 3 ++- 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 testnet-faucet/.env.sample create mode 100644 testnet-faucet/README.md diff --git a/testnet-faucet/.env.sample b/testnet-faucet/.env.sample new file mode 100644 index 0000000000..d09ef8484f --- /dev/null +++ b/testnet-faucet/.env.sample @@ -0,0 +1,6 @@ +VALIDATOR_ADDRESS= +MNEMONIC= +TESTNET_URL_1= +TESTNET_URL_2= +ACCOUNT_ADDRESS= + diff --git a/testnet-faucet/README.md b/testnet-faucet/README.md new file mode 100644 index 0000000000..5adb5d7e2b --- /dev/null +++ b/testnet-faucet/README.md @@ -0,0 +1,17 @@ +# Nym Testnet Token Faucet Page + +## Installation + +`yarn install` + +## Environment variabled + +Create a file in the root directory called `.env`. Copy the everything from the `.env.sample` file into the `.env` file and add the required values` + +## Development environment + +`yarn dev` + +## Build + +`yarn build` diff --git a/testnet-faucet/package.json b/testnet-faucet/package.json index d4761813a3..ffc79c8def 100644 --- a/testnet-faucet/package.json +++ b/testnet-faucet/package.json @@ -4,7 +4,8 @@ "description": "testnet faucet for token aquisition", "license": "MIT", "scripts": { - "dev": "yarn parcel ./src/index.html" + "dev": "yarn parcel ./src/index.html", + "build": "yarn parcel build ./src/index.html" }, "dependencies": { "@emotion/react": "^11.6.0",