Skip to main content

Build From Source

Setup For Contributors​

If you want to contribute to the Calimero framework or customize its functionality, you can build it from source.

Prerequisites​

  • Ensure Rust is installed. If not, follow the instructions on the Rust website.

Troubleshooting​

  • If Rust dependencies fail, ensure your Rust installation is up-to-date:

    rustup update

  • Verify that you have all required permissions to run the node.

For further support, open an issue on GitHub.

Setup steps​

Setup consists of few steps and is around 9 minutes long. (mostly waiting for project dependencies to download)

  1. Clone repository from GitHub (1min)
  2. Position in the root of the project (< 1min)
  3. Initialize and run node (~7 mins)

1. Clone repository from GitHub​

Clone using SSH
git clone git@github.com:calimero-network/core.git

2. Position in the root of the project​

Terminal
cd core

3. Initialize and run node​

You can do it in two ways.

  • Using CLI
  • Using Docker compose

If this is your first time initializing the node, the process may take a little bit more time until all dependencies are downloaded. It will take around 7 minutes but can vary depending on your internet connection.

1. Initialize node​

Terminal
cargo run -p merod -- --node-name node1 init --server-port 2428 --swarm-port 2528

Node configuration file contains protocol defined metada.

node-config

2. Run node​

Terminal
cargo run -p merod -- --node-name node1 run

Wait for a few moments and node logs should appear.

Node running

When you see something like this that means that node is now ready for use.

Was this page helpful?
Need some help? Check Support page