Git Product home page Git Product logo

explorer's Introduction

XRPL Explorer

This repo contains the source code for the block explorer of the XRP Ledger hosted at livenet.xrpl.org.

This project was bootstrapped with Create React App. You can find the most recent version of guide here.

Basic requirements

Install Node and NPM

The project requires node@14. Follow installation instructions on nodejs.org.

Google BigQuery Setup

This setup is required for the Tokens page of the explorer to function:

  1. Select or create a Cloud Platform project.
  2. Enable the Google BigQuery API.
  3. Set up authentication with a service account

Once you have completed these steps and generated the JSON key file, you must populate the following environment variables in the .env file with their corresponding values from the JSON key file:

GOOGLE_APP_PROJECT_ID=your-project-id
GOOGLE_APP_PRIVATE_KEY=-----BEGIN PRIVATE KEY-----\n...
GOOGLE_APP_CLIENT_EMAIL=your-client-email

Install, compile, and run

  • npm install then
  • npm start for development mode, or
  • npm run build then npm run prod-server for production mode

Running on Parallel Networks

Testnet mode

  1. Replace RIPPLED_HOST=s2.ripple.com with RIPPLED_HOST=s.altnet.rippletest.net in the .env file
  2. Remove RIPPLED_SECONDARY from .env (optional, but the extra validator subscriptions are not necessary)
  3. Add REACT_APP_ENVIRONMENT=testnet to .env to enable TESTNET banner

Devnet mode

  1. Replace RIPPLED_HOST=s2.ripple.com with RIPPLED_HOST=s.devnet.rippletest.net in the .env file
  2. Remove RIPPLED_SECONDARY from .env (optional, but the extra validator subscriptions are not necessary)
  3. Add REACT_APP_ENVIRONMENT=devnet to .env to enable TESTNET banner

Testing

Run unit tests

  • Run tests in watch mode npm test
  • Run test to produce coverage npm run test:coverage
  • To open coverage HTML report in app root do open coverage/index.html

Debugging Unit Tests in Chrome

  1. Place debugger; in your unit test
  2. Do npm run test:debug
  3. Open about:inspect in Chrome
  4. Click on inspect link
  5. Chrome Developer Tools will be open, click play button
  6. Now test will start running and will stop on your debugger;
  7. You know the rest ;)

Targeted view sizes

  1. phone-only: 0px - 375px
  2. tablet-portrait-up: 375px - 600px
  3. tablet-landscape-up: 600px - 900px
  4. desktop-up: 900px - 1200px
  5. big-desktop-up: 1200px and up

Targeted languages

  1. US English (default)
  2. Simplified Chinese
  3. Japanese
  4. Korean
  5. Mexican Spanish
  6. Brazilian Portuguese

Additional Documentation

React Documentation

explorer's People

Contributors

ckniffen avatar mvadari avatar dependabot[bot] avatar mayurbhandary avatar ledhed2222 avatar mukulljangid avatar shawnxie999 avatar connorjchen avatar jst5000 avatar natenichols avatar jonathanlei avatar pdp2121 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.