Skip to content

Commit

Permalink
chore: update readme (#5887)
Browse files Browse the repository at this point in the history
* chore: Update readme

* chore: Update readme
  • Loading branch information
garethfuller committed Jul 23, 2024
1 parent 7e03ce4 commit bc66919
Showing 1 changed file with 9 additions and 30 deletions.
39 changes: 9 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Balancer Frontend App (v2)
# ⛔️ This app is now deprecated

Official frontend app for the Balancer protocol (v2)
We have launched a new UI for the Balancer protocol, which is available at
[https://balancer.fi](https://balancer.fi). The source code for the new UI is
available at
[https://github.com/balancer/frontend-v3](https://github.com/balancer/frontend-v3).

_Note, there is an exception where by the veBAL page is still available at
[https://app.balancer.fi/vebal](https://app.balancer.fi/vebal). We will continue to maintain the veBAL page of this
UI until we migrate that functionality to the new UI._

## Development

Expand Down Expand Up @@ -99,34 +106,6 @@ export DOCKER_DEFAULT_PLATFORM=linux/amd64

source: https://stackoverflow.com/questions/65612411/forcing-docker-to-use-linux-amd64-platform-by-default-on-macos

## Self-Hosting

As we believe in decentralization at all layers, we've made it easy to host your own Balancer Frontend.

### Docker Production Image

We've created a production ready [docker image](./Dockerfile) runs
a pre-built version of Balancer Frontend-v2 using nginx. You'll need your own
[Infura](https://infura.io), [Alchemy](https://www.alchemy.com/), and
[Blocknative](https://blocknative.com) API keys in order to fetch data and
execute transactions.

Here's an example of how to run the container. This can also be found in [scripts/run-docker.sh](./scripts/run-docker.sh).

```bash
docker run \
-e INFURA_PROJECT_ID= \ # Required
-e ALCHEMY_KEY= \ # Required
-e BLOCKNATIVE_DAPP_ID= \ # Required
balancerfi/frontend-v2
```

### Custom RPC urls

To override RPC network config set in `src/lib/config`, you can use the following environment variables:

`VITE_RPC_URL_<networkId>=XXX`

### One Click Deploys

The frontend can easily be deployed to any static host. Use the buttons below to spin up an instance. You will be prompted to provide your Infura Project ID, Alchemy Key, and Blocknative Dapp ID as these are required for the frontend to work correctly.
Expand Down

0 comments on commit bc66919

Please sign in to comment.