Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README with some "how to run this correctly" instructions #43

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README with some "how to run this correctly" instructions #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
READ_ONLY_REDIS_URL=http://127.0.0.1:6379
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```