Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add beacon-API to README #958

Merged
merged 3 commits into from
Apr 4, 2024
Merged

docs: add beacon-API to README #958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e35c90
docs: add beacon-API to README
avilagaston9 Apr 4, 2024
b50e41d
Merge branch 'main' into beacon-api-to-readme
avilagaston9 Apr 4, 2024
b8e357b
Add warning about checkpoint-sync
avilagaston9 Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
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
MegaRedHand marked this conversation as resolved.
Show resolved Hide resolved

#▶️ iex: @ Runs an interactive terminal with the main supervisor setup.
iex: compile-all
Expand Down
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
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
Loading