Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 2.16 KB

setup_guide.md

File metadata and controls

88 lines (70 loc) · 2.16 KB

Nim Blockchain Node Setup Guide

Introduction

This document outlines detailed, step-by-step instructions to set up your Nim Blockchain Node development environment on Windows 11. Follow these explicit steps to configure your system properly and efficiently.

🔧 Prerequisites

Before proceeding, ensure your system meets the following prerequisites:

📌 Installation Steps

1. Install Nim

  • Download and install the latest Nim version from Nim Official Site.
  • Confirm the installation in your terminal:
nim --version

2. Install Nimble (Nim's Package Manager)

  • Nimble comes bundled with Nim; ensure it's properly installed by running:
nimble --version

2. Clone the Repository

git clone https://github.com/dkrizhanovskyi/nim-blockchain-node.git
cd nim-blockchain-node

3. Install Project Dependencies

Run Nimble to install necessary dependencies:

nimble install

⚙️ Project Structure

nim-blockchain-node/
├── config/
├── docs
├── scripts
├── src
│   ├── core_engine
│   ├── cryptography
│   ├── network
│   └── storage
└── tests

🚀 Building the Node

To build the blockchain node:

nimble build

🧪 Running Tests

Execute all unit and integration tests:

nimble test

🖥️ Running the Node

Run the node after building:

.\main.exe

You should see the node initialization logs:

🚀 Starting Nim Blockchain Node...
✅ Block stored successfully.
🎉 Node initialized successfully.

🛡️ Security and Maintenance

  • Regularly update Nim and dependencies.
  • Monitor and integrate cryptographic library updates.
  • Follow best practices for security audits and code reviews.

Your Nim Blockchain Node is now successfully set up and ready for further development or deployment. Refer to overview.md and architecture.md for deeper insights.