Skip to content

Commit

Permalink
fix: update image in Flair Indexing docs (#293)
Browse files Browse the repository at this point in the history
Co-authored-by: aram.eth <[email protected]>
  • Loading branch information
kasrakhosravi and aramalipoor authored Sep 15, 2023
1 parent fe353ac commit 6256a45
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 440 deletions.
18 changes: 7 additions & 11 deletions docs/build-on-linea/tooling/data-indexers/flair.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,7 @@ Real-time and historical custom data indexing for any evm chain.

[Flair](https://flair.dev) offers reusable **indexing primitives** (such as fault-tolerant RPC ingestors, custom processors, re-org aware database integrations) to make it easy to receive, transform, store and access your on-chain data.

<img
src={
require("@site/static/img/docs/build-on-linea/tooling/flair.svg").default
}></img>
<br />
[![flair architecture](https://imgur.com/0q5bHZK.png)](https://docs.flair.dev/)


## Why Flair?
Expand All @@ -38,7 +34,7 @@ Compared to other alternatives the main reasons are:

## Getting Started

1️⃣ Clone the [starter boilerplate](https://github.com/flair-sdk/starter-boilerplate) template and follow the instructions:
1️⃣ Clone the [starter boilerplate](https://github.com/flair-sdk/starter-boilerplate) template and follow the instructions

```bash
git clone https://github.com/flair-sdk/starter-boilerplate.git
Expand All @@ -48,7 +44,7 @@ git clone https://github.com/flair-sdk/starter-boilerplate.git

Boilerplate instructions will create a **new cluster**, generate **an API Key**, and set up a manifest.yml to index your **first contract** with **sample custom processor** scripts.

Learn more about the [structure of manifest.yml](https://docs.flair.build/reference/manifest.yml).
Learn more about the [structure of manifest.yml](https://docs.flair.dev/reference/manifest.yml).

:::

Expand Down Expand Up @@ -79,7 +75,7 @@ Remember that you can add up to 10 RPC endpoints for resiliency.
}
```

3️⃣ Sync some historical data using [backfill command](https://docs.flair.build/reference/backfilling). Remember that `enabled: true` flag in your `config` enabled your indexer to capture data in real-time already.
3️⃣ Sync some historical data using [backfill command](https://docs.flair.dev/reference/backfilling). Remember that `enabled: true` flag in your `config` enabled your indexer to capture data in real-time already.

```bash
# backfill certain contracts or block ranges
Expand All @@ -91,9 +87,9 @@ pnpm flair backfill --chain 59140 --min-timestamp="30 mins ago" -d backward
```


4️⃣ [Query](https://docs.flair.build/#getting-started) your custom indexed data.
4️⃣ [Query](https://docs.flair.dev/#getting-started) your custom indexed data.

5️⃣ Stream the data to your [own database](https://docs.flair.build/reference/database#your-own-database).
5️⃣ Stream the data to your [own database](https://docs.flair.dev/reference/database#your-own-database).

## Examples

Expand All @@ -111,4 +107,4 @@ Explore real-world usage of Flair indexing primitives for various use-cases.

## Need help?

[Our engineers](https://docs.flair.build/talk-to-an-engineer) are available to help you at any stage.
[Our engineers](https://docs.flair.dev/talk-to-an-engineer) are available to help you at any stage.
Loading

1 comment on commit 6256a45

@vercel
Copy link

@vercel vercel bot commented on 6256a45 Sep 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.