Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MattPereira committed May 16, 2024
1 parent c73e4d4 commit 59ab9ea
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,40 @@

Data analytics for all Buidl Guidl stream contracts deployed on Ethereum and Optimism. The goal for this buidl is to provide the community with more information in order to inspire conversations and ideas that may lead to better outcomes for all parties involved.

### 🏁 Getting Started
## 🏁 Getting Started

1. Start the ponder backend framework
1. Clone the repo

```bash
git clone https://github.com/MattPereira/streamogator.git
```
yarn ponder:dev

2. Install dependencies

```bash
yarn install
```

3. Add environment variables to `./packages/ponder/.env.local`

```
PONDER_RPC_URL_1=https://eth-mainnet.alchemyapi.io/v2/...
PONDER_RPC_URL_10=https://opt-mainnet.g.alchemy.com/v2/...
```

2. Start the frontend
4. Start the ponder backend framework

```bash
yarn ponder:dev
```

5. Start the frontend

```bash
yarn start
```

### 🛣️ Roadmap
## 🛣️ Roadmap

- Click on a table row to see full details for transaction or builder in a modal pop up or details page
- Sort withdrawals by gas used
Expand Down
2 changes: 1 addition & 1 deletion packages/ponder/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ yarn-error.log*

# Ponder
/generated/
/.ponder/
/.ponder/

0 comments on commit 59ab9ea

Please sign in to comment.