README.md

envio-indexer

⚠️ This is still under development. Entities might change!

Envio indexer for circles v1 and v2

Prerequisites

Before you start, make sure you have the following tools installed on your machine:

• Node.js v20 or higher
• pnpm
• Docker (if you want to run locally)

Installation

1. Clone this repository:

git clone https://github.com/aboutcircles/envio-indexer.git

2. Install the dependencies with Yarn:

pnpm install

Running locally

To run a local instance of envio indexer, docker is required.

Run the indexer with the command:

pnpm envio dev

Contributing

Contributions are welcome! If you find a bug or have improvement ideas, feel free to open an issue or submit a pull request.