Skip to content

01 Getting Started

Jump to bottom
xvcf edited this page Feb 21, 2025 · 2 revisions

🚀 Getting Started

📖 Prerequisites

  • Go 1.23.4 or later. If you don't already have go installed, you can do this as described here

📂 Installation

  1. Clone the repository:

    git clone https://github.com/NXT-Crypto/nxtchain.git
cd nxtchain

  2. Install required go dependencies:

    go mod tidy

🔨 Building the Project

To build the project, simply run the provided buildscript build.sh:

# Mark build.sh as executable if needed
chmod +x ./build.sh

# Run the script
./build.sh

The buildscript will then build the NXTChain for multiple operating systems. You will find your built binaries in the ./build folder. The structure is ./build/COMPONENT/OS/nxtchain_COMPONENT_OS_ARCH (with a .exe ending for Windows binaries). As an example, the path for a miner for Linux amd64 would be ./build/miner/linux/nxtchain_miner_linux_amd64.

image

If automatic builds without user inputs are required, you can add arguments after ./build.sh as shown here:

# Build the miner
./build.sh miner

# Build the node
./build.sh node

# Build the wallets
./build.sh wallet

# Build everything
./build.sh all

If you are using Windows to build the NXTChain project, use a tool such as Git Bash or WSL to run the buildscript. A batch file for Windows is NOT provided.

If you don't want to build the NXTChain yourself, you will always find built binaries from the latest commit on the releases page. These files are automatically being built on GitHub, you can track the building process on the actions page.

Clone this wiki locally