Lux Docs

Quick Start

Get the explorer running locally in minutes

Prerequisites

  • Docker and Docker Compose
  • Node.js 22+ and pnpm 10+ (for frontend development)
  • Elixir 1.19+ and Erlang 27+ (for backend development)
  • A running luxd node with JSON-RPC access

Docker Compose (Fastest)

git clone https://github.com/luxfi/explore.git
cd explore
docker compose up -d

This starts PostgreSQL, Redis, Blockscout backend, and the Next.js frontend. Open http://localhost:3000.

Frontend Only

If you have a running backend API:

git clone https://github.com/luxfi/explore.git
cd explore
pnpm install
cp .env.example .env.local

# Edit .env.local with your API endpoint
# NEXT_PUBLIC_API_HOST=http://localhost:4000

pnpm dev

Open http://localhost:3000.

Backend Only

git clone https://github.com/luxfi/explorer.git
cd explorer
mix deps.get
mix compile

# Set environment
export DATABASE_URL="postgresql://blockscout:blockscout@localhost:5432/explorer"
export ETHEREUM_JSONRPC_HTTP_URL="http://localhost:9650/ext/bc/C/rpc"
export CHAIN_ID=96369
export COIN=LUX
export NETWORK="LUX Network"

mix phx.server

Backend API available at http://localhost:4000.

Verify Indexing

# Check health
curl http://localhost:4000/api/v2/stats

# Check latest blocks
curl http://localhost:4000/api/v2/blocks

On this page