Skip to content

Commit

Permalink
Include pnpm in readme. (#207)
Browse files Browse the repository at this point in the history
  • Loading branch information
jfarid27 authored Nov 21, 2024
1 parent 4f41fa4 commit d60409d
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Multi-chain indexer for Velodrome V2 and Aerodrome

This repo contains the indexer for [Velodrome V2](https://velodrome.finance/) on Optimism and [Aerodrome](https://aerodrome.finance/) on Base.
This repo contains the indexer for [Velodrome V2](https://velodrome.finance/) and [Aerodrome](https://aerodrome.finance/) across multiple chains.

The indexer is written in TypeScript.

Expand All @@ -26,36 +26,47 @@ The indexer is written in TypeScript.

### Development

To develop the indexer further, refer to the [Envio documentation](https://docs.envio.dev/docs/overview) for additional guidelines.
To develop the indexer further, refer to the [Envio documentation](https://docs.envio.dev/docs/overview) for additional guidelines. It is expected to run the
indexer with [pnpm](https://pnpm.io/).

### Installation

To install the necessary packages and dependencies, run pnpm's installation. The current system
is running with pnpm version 9.11.0.

```bash
pnpm i
```


#### Notable Envio CLI commands

This command will generate the `generated` folder for the repo based on the latest `config.yaml` and `schema.graphql` files.

```bash
envio codegen
pnpm envio codegen
```

During local testing, this command will drop all the existing information in the database and create new tables for a new local run.

```bash
envio local db-migrate setup
pnpm envio local db-migrate setup
```

### Running the indexer

Clone this repo and then run (this single command will spin up the required docker images, run DB migrations, perform codegen for any changes and start the indexer)

```bash
envio dev
pnpm envio dev
```

> Make sure you have Docker application running
To stop the indexer, run

```bash
envio stop
pnpm envio stop
```
### Hydra-mode

Expand Down

0 comments on commit d60409d

Please sign in to comment.