XandScan

Getting Started

Quick Start Guide

Get XandScan up and running in under 5 minutes

Prerequisites

Before you begin, ensure you have:

  • •Node.js 20.x or higher - Download here
  • •npm or yarn package manager (comes with Node.js)
  • •Git - For cloning the repository

Installation

Step 1: Clone the Repository

git clone https://github.com/your-org/xandscan.git
cd xandscan

Step 2: Install Dependencies

npm install
# or
yarn install

Step 3: Set Up Environment Variables

Create a .env.local file in the root directory:

# Optional: Customize version
NEXT_PUBLIC_APP_VERSION=1.0.0

# Optional: API configuration (uses defaults if not set)
NEXT_PUBLIC_XANDEUM_RPC_URL=https://api.xandeum.network

Note: Environment variables are optional. XandScan uses hardcoded pNode endpoints by default.

Step 4: Run Development Server

npm run dev
# or
yarn dev

Open http://localhost:3000 in your browser to see XandScan running!

Building for Production

To create an optimized production build:

npm run build
npm run start

The build process:

  • •Compiles TypeScript to JavaScript
  • •Optimizes bundles with code splitting
  • •Generates static pages where possible
  • •Minifies CSS and JavaScript

Verifying Installation

Once the server is running, you should see:

  • •Dashboard: Network statistics and health grade
  • •Top Nodes: Grid of best performing pNodes
  • •Network Analytics: Geographic distribution and insights
  • •Loading Time: Initial load in 6-7 seconds (live data)

Common Issues

Port 3000 already in use

Solution: Change the port by running PORT=3001 npm run dev

Module not found errors

Solution: Delete node_modules and .next, then run npm install again

Data not loading

Solution: This is normal if pNode endpoints are unreachable. Check your internet connection and firewall settings.

Next Steps