Skip to content

Commit

Permalink
add env file instructions (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
euharrison authored Jul 22, 2024
1 parent 03f7b38 commit 42e28bc
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,22 @@ The indexer is composed of a set microservices and a webserver, each one of thes
- `pos`: fetches the validator set each new epoch
- `rewards`: fetches PoS rewards each new epoch
- `governance`: fetches new proposal and the corresponding votes
- `parameterd`: fetches the chain parameters
- `parameters`: fetches the chain parameters

The `webserver` is responsible to serve the data via a REST API, which are described in the `swagger.yml` file in the project root.

![Namada indexer architecture](docs/architecture.png "Architecture")

## How to run

Create the `.env` file. You can use the `.env_sample` as a reference

```
cp .env_sample .env
```

### With docker

- Get a Namada RPC url
- [Either create a local chain ](https://github.com/anoma/namada/blob/main/scripts/gen_localnet.py)
- Or use a Public RPC
Expand All @@ -29,12 +36,13 @@ The `webserver` is responsible to serve the data via a REST API, which are descr
- Run `just docker-run`

### Without docker

- Install rust/cargo
- Get a Namada RPC url
- [Either create a local chain ](https://github.com/anoma/namada/blob/main/scripts/gen_localnet.py)
- Or use a Public RPC
- Get a network `CHAIN_ID`
- Use the `run.sh` script inside each package. Keep in mind that PoS package have to be run always while other service might not
- Use the `run.sh` script inside each package. Keep in mind that PoS package have to be run always while other service might not

## Testing via seeder

Expand Down

0 comments on commit 42e28bc

Please sign in to comment.