From 5ec7296c1eb2105a623f15285ea7eb855eebe2c3 Mon Sep 17 00:00:00 2001 From: Wan Qi Chen <495709+wa0x6e@users.noreply.github.com> Date: Wed, 19 Apr 2023 11:57:11 +0400 Subject: [PATCH] [chore] Update doc --- .env.example | 2 +- README.md | 23 ++++++++++++++++++++--- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/.env.example b/.env.example index b052dc8b..f734db7e 100644 --- a/.env.example +++ b/.env.example @@ -1 +1 @@ -HUB_URL=https://snapshot.org +HUB_URL=https://hub.snapshot.org diff --git a/README.md b/README.md index b2004076..aac352f3 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,22 @@ for snapshot-hub, for proposals' votes. ## Project Setup -> yarn +### Dependencies -Set the hub API url in the `.env` file +Install the dependencies ``` -HUB_URL= +yarn +``` + +_This project does not require a database, but may need larger server storage capacity for the cached files_ + +### Configuration + +Edit the hub API url in the `.env` file if needed + +``` +HUB_URL=https://hub.snapshot.org ``` ## Compiles and hot-reloads for development @@ -33,6 +43,13 @@ yarn lint yarn typecheck ``` +## Build for production + +``` +yarn build +yarn start +``` + ## License [MIT](https://github.com/snapshot-labs/envelop-ui/blob/bootstrap-app/LICENSE)