From d60409d8c298dab3a56bdfcb8de58e0d4e4de71b Mon Sep 17 00:00:00 2001 From: "Jalil F." Date: Thu, 21 Nov 2024 10:43:31 -0500 Subject: [PATCH] Include pnpm in readme. (#207) --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0546676..3e64333 100644 --- a/README.md +++ b/README.md @@ -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. @@ -26,20 +26,31 @@ 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 @@ -47,7 +58,7 @@ envio local db-migrate setup 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 @@ -55,7 +66,7 @@ envio dev To stop the indexer, run ```bash -envio stop +pnpm envio stop ``` ### Hydra-mode