From fd8c1b979790d5adbf4f2934c551796abff8b4c0 Mon Sep 17 00:00:00 2001
From: Jamie Dubs <jamie@jamiedubs.com>
Date: Wed, 29 Jun 2022 13:56:54 -0400
Subject: [PATCH] Draft some 'how to run this correctly' setup instructions

---
 .env.sample |  1 +
 README.md   | 23 +++++++++++++++++++++++
 2 files changed, 24 insertions(+)
 create mode 100644 .env.sample

diff --git a/.env.sample b/.env.sample
new file mode 100644
index 0000000..f84e887
--- /dev/null
+++ b/.env.sample
@@ -0,0 +1 @@
+READ_ONLY_REDIS_URL=http://127.0.0.1:6379
diff --git a/README.md b/README.md
index 3048acf..310de15 100644
--- a/README.md
+++ b/README.md
@@ -9,3 +9,26 @@ A straw poll website that enables a simple straw-poll for Helium related initiat
 * A block height deadline is set for the tally to be taken.
 * Votes are tallied by the HNT voting "power" of the account. One HNT = 1 Vote.
 * DCs sent to an outcome address will be flushed from the system after voting is complete.
+
+## Setup/Contributing
+
+Bootstrap and configure your .env
+
+```
+cp .env.sample .env
+# edit and set READ_ONLY_REDIS_URL
+```
+
+**(TODO what exactly is READ_ONLY_REDIS_URL pointing at? Some kind of Redis HTTP API? How does one enable that? etc)**
+
+Install dependencies using `yarn`:
+
+```sh
+yarn install
+```
+
+Run the app:
+
+```sh
+yarn dev
+```