Skip to content

Commit

Permalink
.
Browse files Browse the repository at this point in the history
  • Loading branch information
uiii committed Jan 22, 2024
1 parent 5cb5b7a commit 115f0df
Showing 1 changed file with 0 additions and 29 deletions.
29 changes: 0 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@ Calamar is a block explorer for Polkadot, Kusama and their parachains. The explo

This app is based on [Create React App](https://facebook.github.io/create-react-app/docs/getting-started).

> [!WARNING]
> Since January 31, Calamar and its data source can only be **self-hosted**.
> This is following the deprecation of Firesquid archives and its resulting effect on Giant Squid.
> We apologize for any inconvenience.
>
> To setup data sources follow this guide.
## Setup

Clone the repo and install the NPM dependencies.
Expand All @@ -23,28 +16,6 @@ $ npm install

Edit `src/networks.json` and configure your network and its data source's endpoints.

<details>
<summary>Network configuration structure</summary>

- **name**: network identificator used in url's etc (required, `"polkadot"`)
- **displayName**: name of the network to be displayed in the app (required, `"Polkadot"`)
- **icon**: path to icon asset (required, e.g. `"/assets/network-icons/polkadot.svg"`)
- **color**: color associated with the network (optional, e.g. `"#e6007a"`)
- **website**: website of the network (optional, e.g. `"https://polkadot.network/"`)
- **parachainId**: id of the parachaing (optional, e.g. `0`)
- **relayChain**: `name` of relay chain network (optional, e.g. `"polkadot"`)
- **prefix**: SS58 prefix (required, e.g. `0`)
- **decimals**: number of decimal for the network's symbol (required, e.g. `10`)
- **symbol**: network's symbol (required, `"DOT"`)
- **squids**:
- **archive**: GraphQL API explorer of the Firesquid archive (required, e.g. `"https://polkadot.explorer.subsquid.io/graphql"`)
- **explorer**: GiantSquid explorer squid (optional, but highly recommended, e.g. `"https://squid.subsquid.io/gs-explorer-polkadot/graphql"`)
- **main**: GiantSquid main squid (optional, e.g. `"https://squid.subsquid.io/gs-main-polkadot/graphql"`)
- **identites**: GiantSquid main squid if it contains indentity data (optional, e.g. `"https://squid.subsquid.io/gs-main-polkadot/graphql"`)
- **stats**: GianSquid stats squid (optional, e.g. `"https://squid.subsquid.io/gs-stats-polkadot/graphql"`)
- **coinGeckoId**: CoinGecko network ID to fetch USD values (optional, `"polkadot"`)
</details>

## Run locally

To start the application locally, run the command
Expand Down

0 comments on commit 115f0df

Please sign in to comment.