Skip to content

Commit

Permalink
docs: add beacon-API to README (#958)
Browse files Browse the repository at this point in the history
  • Loading branch information
avilagaston9 authored Apr 4, 2024
1 parent 39a9412 commit 0c460da
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ grafana-clean:

#▶️ start: @ Start application with Beacon API.
start: compile-all
iex -S mix phx.server
iex -S mix run -- --beacon-api

#▶️ iex: @ Runs an interactive terminal with the main supervisor setup.
iex: compile-all
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,22 @@ Some public endpoints can be found in [eth-clients.github.io/checkpoint-sync-end
> The data retrieved from the URL is stored in the DB once the node is initiated (i.e. the iex prompt shows).
> Once this happens, following runs of `make iex` will start the node using that data.
### Beacon API

You can start the application with the Beacon API on the default port `4000` running:
```shell
make start
```

You can also specify a port with the "--beacon-api-port" flag:

```shell
iex -S mix run -- --beacon-api --beacon-api-port <your_port_here>
```
> [!WARNING]
> In case checkpoint-sync is needed, following the instructions above will end immediately with an error (see [Checkpoint Sync](#checkpoint-sync)).
>
### Tests, linting and formatting

Our CI runs tests, linters, and also checks formatting and typing.
Expand Down

0 comments on commit 0c460da

Please sign in to comment.