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

Jump to bottom

Updated README with 'table of content' and troubleshooting guidelines #2017

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Updated README with 'table of content' and troubleshooting guidelines #2017

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
28ac029
Updated README with 'table of content' and troubleshooting guidelines
Sep 22, 2024
ac5667d
Merge branch 'berachain:main' into main
Favy217 Sep 23, 2024
a8e8b3b
Merge branch 'main' into main
Favy217 Sep 24, 2024
226447c
Merge branch 'main' into main
Favy217 Sep 26, 2024
ce4564f
Merge branch 'main' into main
Favy217 Sep 28, 2024
beb07a9
Merge branch 'main' into main
Favy217 Sep 30, 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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ _The project is still heavily under construction, see the [disclaimer below](#st

</div>

## Table of Contents

1. [What is BeaconKit?](#what-is-beaconkit)
2. [Supported Execution Clients](#supported-execution-clients)
3. [Running a Local Development Network](#running-a-local-development-network)
4. [Multinode Local Devnet](#multinode-local-devnet)
5. [Troubleshooting](#troubleshooting)
6. [Status](#status)

## What is BeaconKit?

[BeaconKit](https://docs.berachain.com/learn/what-is-beaconkit) is a modular framework for building EVM based consensus clients.
Expand Down Expand Up @@ -72,6 +81,14 @@ preloaded with the native EVM token.

Please refer to the [Kurtosis README](https://github.com/berachain/beacon-kit/blob/main/kurtosis/README.md) for more information on how to run a multinode local devnet.

## Troubleshooting

If you encounter issues when running the commands, here are some common fixes:

1. **Docker not starting**: Ensure Docker is running, and you have enough allocated resources (RAM, CPU).
2. **Golang version errors**: Check that you have Go 1.23.0 or above installed by running `go version`.
3. **Port conflicts**: If you receive a port conflict error, try stopping other services running on the same port or change the port configuration in the `docker-compose.yml` file.

## Status

This project is work in progress and subject to frequent changes as we are still working on wiring up the final system. Audits on BeaconKit are still ongoing, and in progress at the moment. We don't recommend using BeaconKit in a production environment yet.