diff --git a/README.md b/README.md index 2d0cc6d1..3ae91f74 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ 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. @@ -20,7 +20,14 @@ The `webserver` is responsible to serve the data via a REST API, which are descr ## 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 @@ -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