xrpl-dev-portal/docs/index.page.tsx

import * as React from 'react';
import { useThemeHooks } from '@redocly/theme/core/hooks';
import { NavList } from "shared/components/nav-list";
import { Link } from "@redocly/theme/components/Link/Link";

export const frontmatter = {
  seo: {
    title: 'XRP Ledger Documentation & Developer Resources',
    description: "Explore XRP Ledger documentation and other blockchain developer resources needed to start building and integrating with the ledger.",
  }
};

const recommendedPages = [
  {
    description: 'Public API Methods',
    link: '/docs/references/http-websocket-apis/public-api-methods/',
  },
  {
    description: 'Run a Validator',
    link: '/docs/infrastructure/configuration/server-modes/run-rippled-as-a-validator/',
  },
  {
    description: 'Reserves',
    link: '/docs/concepts/accounts/reserves/',
  },
  {
    description: 'Transaction Types',
    link: '/docs/references/protocol/transactions/types/',
  }
];

const useCases = [
  {
    title: 'On-Chain Finance',
    id: 'on-chain-finance-use-cases',
    imgClass: 'wallet-illustration',
    subItems: [
      {
        description: 'Algorithmic Trading',
        link: '/docs/use-cases/defi/algorithmic-trading/',
      },
      {
        description: 'List XRP as an Exchange',
        link: '/docs/use-cases/defi/list-xrp-as-an-exchange/',
      },
      {
        description: 'Payment Types',
        link: '/docs/concepts/payment-types/',
      },
    ],
  },
  {
    title: 'Tokens',
    id: 'token-use-cases',
    imgClass: 'token-illustration',
    subItems: [
      {
        description: 'Stablecoin Issuer',
        link: '/docs/use-cases/tokenization/stablecoin-issuer/',
      },
      {
        description: 'NFT Marketplace',
        link: '/docs/use-cases/tokenization/nft-mkt-overview/',
      },
      {
        description: 'Digital Artist',
        link: '/docs/use-cases/tokenization/digital-artist/',
      },
    ],
  },
  {
    title: 'Payments',
    id: 'payments-use-cases',
    imgClass: 'connections-illustration',
    subItems: [
      {
        description: 'Peer-to-Peer Payments',
        link: '/docs/use-cases/payments/peer-to-peer-payments-uc/',
      },
      {
        description: 'Cross-Currency Payments',
        link: '/docs/concepts/payment-types/cross-currency-payments/',
      },
      {
        description: 'Smart Contracts',
        link: '/docs/use-cases/payments/smart-contracts-uc/',
      },
    ],
  },
];
const intermediateVideos = [
  {
    src: require('../static/img/backgrounds/docs-advanced-payment-features@2x.png'),
    title: 'Advanced Payment Features',
    url: 'https://www.youtube.com/embed/e2Iwsk37LMk?rel=0&showinfo=0&autoplay=1',
  },
  {
    src: require('../static/img/backgrounds/docs-governance@2x.png'),
    title: 'Governance and the Amendment Process',
    url: 'https://www.youtube.com/embed/4GbRdanHoR4?rel=0&showinfo=0&autoplay=1',
  },
  {
    src: require('../static/img/backgrounds/docs-sidechains@2x.png'),
    title: 'Federated Sidechains',
    url: 'https://www.youtube.com/embed/NhH4LM8NxgY?rel=0&showinfo=0&autoplay=1',
  },
];
const getStartedVideos = [
  {
    src: require('../static/img/backgrounds/docs-intro-to-XRP-ledger@2x.png'),
    title: 'Intro to XRP Ledger',
    url: 'https://www.youtube.com/embed/sVTybJ3cNyo?rel=0&showinfo=0&autoplay=1',
  },
  {
    src: require('../static/img/backgrounds/docs-accounts@2x.png'),
    title: 'Accounts',
    url: 'https://www.youtube.com/embed/eO8jE6PftX8?rel=0&showinfo=0&autoplay=1',
  },
  {
    src: require('../static/img/backgrounds/docs-decentralized-exchange@2x.png'),
    title: 'Decentralized Exchange',
    url: 'https://www.youtube.com/embed/VWNrHBDfXvA?rel=0&showinfo=0&autoplay=1',
  },
  {
    src: require('../static/img/backgrounds/docs-tokenization@2x.png'),
    title: 'Tokenization',
    url: 'https://www.youtube.com/embed/Oj4cWOiWf4A?rel=0&showinfo=0&autoplay=1',
  },
];

const devTools = [
  {
    title: 'XRP Faucets',
    link: '/resources/dev-tools/xrp-faucets',
    description: 'Get credentials and test-XRP for XRP Ledger Testnet or Devnet.',
  },
  {
    title: 'WebSocket Tool',
    link: '/resources/dev-tools/websocket-api-tool',
    description: 'Send sample requests and get responses from the rippled API.',
  },
  {
    title: 'XRP Ledger Explorer',
    link: 'https://livenet.xrpl.org',
    description:
      'View validations of new ledger versions in real-time, chart the location of servers in the XRP Ledger.',
  },
  {
    title: 'Transaction Sender',
    link: '/resources/dev-tools/tx-sender',
    description:
      'Test how your code handles various XRP Ledger transactions by sending them over the Testnet to the address.',
  },
];

function UseCasesCard(props: {
  useCase: {
    id: string;
    title: string;
    imgClass: string;
    subItems: { description: string; link: string }[];
  };
}) {
  const { useCase } = props;
  const { useTranslate } = useThemeHooks();
  const { translate } = useTranslate();
  return (
    <div className="col">
      <img className={'use-cases-img img-fluid mb-2 shadow ' + useCase.imgClass} alt={useCase.title} id={useCase.id} />
      <h5 className="mt-4">{translate(useCase.title)}</h5>
      <NavList pages={useCase.subItems} />
    </div>
  );
}

function FlatCard(props: { href: string; title: string; description: string; linkText: string; imgClass }) {
  const { title, description, linkText, href, imgClass } = props;
  return (
    <Link to={href} className="card flat-card float-up-on-hover">
      <img className={'mb-2 ' + imgClass} alt={title} />
      <h5 className="row">
        <div className="nav-link">{title}</div>
      </h5>
      <p className="row faded-text flat-card-padding">{description}</p>
      <div className="col align-button-on-bottom">
        <div className="btn btn-primary btn-arrow" id={href + '-button'}>
          {linkText}
        </div>
      </div>
    </Link>
  );
}

function VideoCard(props: { url: string; title: string; src: string }) {
  const { url, title, src } = props;
  return (
    <div className="col float-up-on-hover">
      <a href={url} id="playvideo" className="btn1" data-url={url}>
        <img alt={title} className="get-started-img video-image" id={title} src={src} />
        <h6 className="pt-3">{title}</h6>
      </a>
    </div>
  );
}

function DevToolCard(props: { link: string; title: string; description: string }) {
  const { link, title, description } = props;
  return (
    <Link to={link} className="col dev-tools-link">
      <h6 className="btn-arrow">{title}</h6>
      <p> {description}</p>
    </Link>
  );
}

function PrimaryButton(props: { href: string; text: string; isArrowUp: boolean }) {
  const { href, text, isArrowUp } = props;
  return (
    <Link className={`btn btn-primary ${isArrowUp ? 'btn-arrow-out' : 'btn-arrow'}`} id={href + '-button'} to={href}>
      {text}
    </Link>
  );
}

export default function Docs() {
  const { useTranslate } = useThemeHooks();
  const { translate } = useTranslate();

  return (
    <div className="landing page-docs page-docs-index landing-builtin-bg overflow-hidden styled-page">
      <div>
        <section className="text-center title-space">
          <div className="col-lg-9 mx-auto text-center">
            <div className="d-flex flex-column-reverse">
              <h1>{translate('Documentation')}</h1>
              <h6 className="eyebrow mb-3">{translate('XRP Ledger Developer Resources')}</h6>
            </div>
          </div>
        </section>

        <section className="container-new ">
          <div className="nav card-grid flat-card-grid card-grid-3xN">
            <div className="col">
              <FlatCard
                href="/docs/concepts/"
                title={translate('Concepts')}
                description={translate('Learn the "what" and the "why" behind fundamental aspects of the XRP Ledger.')}
                linkText={translate('Read the Docs')}
                imgClass="concepts-doc-illustration"
              />
            </div>
            <div className="col">
              <FlatCard
                href="/docs/tutorials/"
                title={translate('Tutorials')}
                description={translate('Get step-by-step guidance to perform common tasks with the XRP Ledger.')}
                linkText={translate('View Tutorials')}
                imgClass="tutorial-illustration"
              />
            </div>
            <div className="col">
              <FlatCard
                href="/docs/references/"
                title={translate('References')}
                description={translate(
                  'Look up reference documentation for the XRP Ledger protocol, API methods, and more.'
                )}
                linkText={translate('View References')}
                imgClass="ref-book-illustration"
              />
            </div>
          </div>
        </section>
        <section className="container-new">
          <h4 className="pb-4">{translate('Use Cases')}</h4>
          <div className="card-grid card-grid-3xN use-cases">
            {useCases.map(useCase => (
              <UseCasesCard useCase={useCase} key={useCase.id} />
            ))}
          </div>
        </section>
        <section className="container-new ">
          <h4 className="pb-4">{translate('Getting Started')}</h4>
          <div className="card-grid card-grid-2xN quickstart-card">
            <div className="col">
              <Link to="/docs/introduction/" className="card float-up-on-hover">
                <h5 className="mt-7">{translate('Introduction to the XRP Ledger')}</h5>
                <p className="mb-8 mt-4">{translate('An introduction to fundamental aspects of the XRP Ledger.')}</p>
                <div className="dg-lg-block mb-3">
                  <div className="btn btn-primary btn-arrow get-started-button">{translate('Introduction')}</div>
                </div>
                <img alt="quick-start" id="quick-start-img" className="quickstart-image" />
              </Link>
            </div>
            <div className="col">
              <div className="card-grid card-grid-2xN video-grid">
                {getStartedVideos.map(video => (
                  <VideoCard url={video.url} title={translate(video.title)} src={video.src} key={video.url} />
                ))}
              </div>
              <div className="align-button-on-bottom">
                <PrimaryButton
                  href="https://www.youtube.com/playlist?list=PLJQ55Tj1hIVZtJ_JdTvSum2qMTsedWkNi"
                  text={translate('Watch Full Series')}
                  isArrowUp={true}
                />
              </div>
            </div>
          </div>
        </section>
        <section className="container-new ">
          <div className="d-flex flex-column-reverse col-sm-8 p-0">
            <h3 className="h4 h2-sm">{translate('Interact with the XRP Ledger in a language of your choice')}</h3>
            <h6 className="eyebrow mb-3">{translate('Explore SDKs')}</h6>
          </div>
          <div className="card-grid card-grid-2xN">
            <div className="col">
              <div className="card-grid langs-cards card-grid-2xN mt-10" id="langs-cards">
                <div className="col langs">
                  <Link to="/docs/tutorials/javascript/">
                    <img alt="Javascript Logo" src={require('../static/img/logos/javascript.svg')} className="circled-logo" />
                    <h5 className="btn-arrow">{translate('Javascript')}</h5>
                  </Link>
                </div>
                <div className="col langs">
                  <Link to="/docs/tutorials/python/">
                    <img alt="Python Logo" src={require('../static/img/logos/python.svg')} className="circled-logo" />
                    <h5 className="btn-arrow">{translate('Python')}</h5>
                  </Link>
                </div>
                <div className="col langs">
                  <Link to="/docs/tutorials/java/build-apps/get-started/">
                    <img alt="Java Logo" src={require('../static/img/logos/java.svg')} className="circled-logo" />
                    <h5 className="btn-arrow">{translate('Java')}</h5>
                  </Link>
                </div>
              </div>
            </div>
            <div className="col center-image">
              <img className="img-fluid sdk-img" />
            </div>
          </div>
        </section>
        <section className="container-new ">
          <h4 className="pb-4">{translate('Intermediate Learning Sources')}</h4>
          <div className="card-grid card-grid-3xN">
            {intermediateVideos.map(video => (
              <VideoCard url={video.url} title={translate(video.title)} src={video.src} key={video.url} />
            ))}
          </div>
        </section>
        <section className="container-new ">
          <div className="card-grid card-grid-2xN">
            <div className="col d-flex align-items-center justify-content-center">
              <img className="dev-tools-img" />
            </div>
            <div className="col explore-links">
              <div className="d-flex flex-column-reverse w-100">
                <h4 className="mb-10">{translate('Explore, Test, Verify')}</h4>
                <h6 className="mb-3">{translate('Explore Dev Tools')}</h6>
              </div>
              <p className="mb-20">
                {translate(
                  'Use these web-based tools to assist during all stages of development, from getting your first payment to testing your implementation for best practices.'
                )}
              </p>
              <div className="card-grid card-grid-2xN">
                {devTools.map(card => (
                  <DevToolCard
                    link={card.link}
                    title={translate(card.title)}
                    description={translate(card.description)}
                    key={card.link}
                  />
                ))}
              </div>
              <PrimaryButton href="/resources/dev-tools" text={translate('View All tools')} isArrowUp={false} />
            </div>
          </div>
        </section>
        <section className="container-new " id="docs-browse-by">
          <div className="row card-grid card-grid-2xN">
            <div className="col" id="popular-topics">
              <h2 className="h4">{translate('Browse By Recommended Pages')}</h2>
              <NavList pages={recommendedPages} />
            </div>
            <div className="col">
              <div className="card cta-card p-8-sm p-10-until-sm br-8">
                <img src={require('../static/img/backgrounds/cta-home-purple.svg')} className="d-none-sm cta cta-top-left" />
                <img src={require('../static/img/backgrounds/cta-home-green.svg')} className="cta cta-bottom-right" />
                <div className="z-index-1 position-relative">
                  <h2 className="h4 mb-8-sm mb-10-until-sm">{translate('Get Free Test XRP')}</h2>
                  <p className="mb-10">
                    {translate(
                      'Connect to the XRP Ledger Testnet network to develop and test your apps built on the XRP Ledger, without risking real money or impacting production XRP Ledger users.'
                    )}
                  </p>
                  <Link className="btn btn-primary btn-arrow" to="/resources/dev-tools/xrp-faucets/">
                    {translate('Generate Testnet Credentials')}
                  </Link>
                </div>
              </div>
            </div>
          </div>
        </section>
        {/* full docs index isn't ported to Redocly
        <section className="container-new">
          <a href="/docs/full-index" className="btn-arrow arrow-purple documentation-index mr-auto">
            {translate('See full documentation index')}
          </a>
        </section>
        */}
      </div>
    </div>
  );
}