Skip to content

Latest commit

 

History

History
134 lines (90 loc) · 4.08 KB

README.md

File metadata and controls

134 lines (90 loc) · 4.08 KB

🔍 Axelarscan UI

The official UI for Axelarscan - Cross-chain explorer for the Axelar Network

🌐 Live Environments

Environment URL
🚀 Mainnet https://axelarscan.io
🧪 Testnet https://testnet.axelarscan.io

🛠️ Development Setup

Prerequisites

  • Node.js 20.19.4 (specified in .nvmrc) - Install via nvm

Local Development

Run the application locally on localhost:3000:

# Switch to the correct Node.js version
nvm use

# Install dependencies
npm ci

# Start development server
npm run dev

Code Quality

# Format code with Prettier
npm run format

# Check code formatting
npm run format:check

# Run ESLint and fix issues
npm run lint

# Check for linting issues
npm run lint:check

Build

# Run TypeScript type checking (no emit)
npm run tsc

# Build project with TypeScript checking
npm run build

Testing

Run the test suite to verify functionality:

# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Run tests with coverage report
npm run test:coverage

🚀 Deployment and Release Process

📋 Overview

Axelarscan UI uses a straightforward deployment process with Vercel. The project uses a single main branch with feature branches for development.

🌍 Environment Setup

Environment variables are managed via a single .env file locally and Vercel environment variables for deployments.

# Copy the example and fill in values for your target environment
cp .env.example .env
Environment Vercel Project
Mainnet axelarscan-mainnet
Testnet axelarscan-testnet
Staging axelarscan-staging
Stagenet axelarscan-stagenet
Devnet Amplifier axelarscan-devnet-amplifier

Each Vercel project has its own environment variables configured in the Vercel dashboard. Locally, set NEXT_PUBLIC_ENVIRONMENT in your .env to target the desired environment.

🔄 Release Process

  1. 👨‍💻 Development:

    • Create feature branches from main using the naming convention feat/* or chore/*
    • Example: feat/add-new-chart or chore/update-dependencies

  2. 🔍 Preview Deployments:

    • Vercel automatically creates preview deployments for branches with the feat/* or chore/* prefix
    • Preview URLs are available directly in the GitHub UI for each commit
    • Branches with other naming patterns (e.g., bugfix/*, hotfix/*) will not trigger preview builds

  3. 🧪 Testing:

    • Test your changes on the Vercel preview URL
    • Make any necessary adjustments in your feature branch

  4. 📦 Release:

    • Once testing is complete, create a Pull Request to merge your feature branch into main
    • After approval and merge to main, Vercel automatically deploys to all environment projects

🛠️ Build Control

The repository includes a vercel.deployment.sh script that controls which branches get deployed:

Status Condition
✅ Builds proceed when • Branch is main, feat/*, or chore/*
• AND the Vercel URL doesn't contain "v1" or "v0"
🛑 Builds are skipped when • Any other branch naming pattern
• OR any deployment URL containing "v1" or "v0" (legacy deployments)

📝 Notes

  • There is no need for environment-specific branches or manual promotion between environments
  • All environments are updated simultaneously when changes are merged to main