Introduction

NorChain Documentation

Welcome to the NorChain Ecosystem documentation. This comprehensive guide covers all aspects of the NorChain blockchain platform, including APIs, applications, and development guides.

What is NorChain?

NorChain is a comprehensive blockchain ecosystem featuring:

  • Blockchain Explorer - Advanced block explorer with real-time data
  • Explorer API - Production-ready REST API for blockchain data
  • Landing Page - Marketing and information website
  • NEX Exchange - Decentralized exchange platform

Architecture Overview

┌─────────────────────────────────────────────────────────┐
│                    Frontend Apps                        │
│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐ │
│  │   Explorer   │  │   Landing    │  │ NEX Exchange │ │
│  │   (Port 3002)│  │  (Port 3010) │  │  (Port 3001) │ │
│  └──────┬───────┘  └──────┬───────┘  └──────┬───────┘ │
│         │                 │                  │          │
└─────────┼─────────────────┼──────────────────┼─────────┘
          │                 │                  │
          └─────────────────┼──────────────────┘

          ┌─────────────────▼──────────────────┐
          │      Explorer API (Port 3000)      │
          │      - REST API                     │
          │      - GraphQL API                  │
          │      - WebSocket Support            │
          └─────────────────┬──────────────────┘

          ┌─────────────────▼──────────────────┐
          │      Database (PostgreSQL/Supabase) │
          └─────────────────────────────────────┘

Key Features

Explorer API

  • ✅ 50+ REST API endpoints
  • ✅ GraphQL API support
  • ✅ Real-time WebSocket updates
  • ✅ JWT & API Key authentication
  • ✅ Rate limiting & caching
  • ✅ Swagger documentation

Explorer App

  • ✅ Real-time blockchain data
  • ✅ Contract interaction
  • ✅ Transaction tracking
  • ✅ Analytics dashboard
  • ✅ Wallet integration

Landing Page

  • ✅ Marketing website
  • ✅ Network statistics
  • ✅ Community information

NEX Exchange

  • ✅ Token swapping
  • ✅ Order management
  • ✅ Portfolio tracking

Getting Started

  1. Clone the repository

    git clone https://github.com/nor-chain/norchain-monorepo
    cd norchain-monorepo
  2. Install dependencies

    npm install
  3. Set up environment variables

  4. Start development servers

    npm run dev

Support


Ready to build? Check out the Getting Started guide!