0.3.0 • Published 9 months ago

@lifi/explorer v0.3.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
9 months ago

license Follow on Twitter

This repository contains the LI.FI Explorer React Component and the LI.FI Explorer Website.

LI.FI Explorer

LI.FI Explorer is available as an

npm:

npm install @lifi/explorer

yarn:

yarn add @lifi/explorer

pnpm:

pnpm add @lifi/explorer

Getting started with LI.FI Explorer

Here is an example of a basic app using the LI.FI Explorer:

import { LiFiExplorer, LiFiExplorerConfig } from '@lifi/explorer';

const explorerConfig: LiFiExplorerConfig = {
  appearance: theme.palette.mode,
  integrator: 'my_project',
  theme: {
    palette: {
      background: {
        default: 'rgba(0,0,0, 0.04)',
        paper: '#fff',
      },
    },
  },
};

export const ExplorerPage = () => {
  return <LiFiExplorer config={explorerConfig} />;
};

Running this repository locally

The easiest way to start local development is to run the following two commands in the root folder of this repository: When using yarn, simply type yarn watch and yarn dev in two terminal windows to start the typescript compilation and the LI.FI Explorer app in development mode. The output of yarn dev will give you the URL to access the page.

Building the projects

Please refer to the individual readme files in the separate packages.

License

This project is licensed under the terms of the Apache-2.0.