Skip to content

Maximize your yield on staking with YieldScan. Scanning yield on nominated proof-of-stake networks. Supported Networks: Polkadot and Kusama.

License

Notifications You must be signed in to change notification settings

yieldscan/yieldscan-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

YieldScan

Maximizing staking yield on substrate based networks(supported networks: Kusama and Polkadot). Currently, the app can be used on https://yieldscan.app .

Table of contents

Currently supported networks

Description

YieldScan is a portfolio management platform for NPoS (nominated proof-of-stake) networks like Kusama and Polkadot. We aim to simplify portfolio management to make yield optimization easier and more accessible, for technical and non-technical users alike.

This project is funded and supported by the Web3 Foundation - under Wave 6.

Development

We are always working on improving our codebase, and welcome any suggestions or contributions.

Contribution Guide

  1. Create an issue for the improvement.

  2. Fork the repo and make changes. Make sure to checkout from develop branch before starting.

  3. Make a PR to develop branch.

Codebase Overview

Important packages:

Pre-requisites

Development guide

  • Clone this or forked repository:

    git clone https://github.com/yieldscan/yieldscan-frontend.git
  • Install the dependencies:

    yarn
  • Add environment variables in .env.local or .env file:

    # Main API endpoint
    NEXT_PUBLIC_API_BASE_URL="http://localhost:5000/api"
    # or NEXT_PUBLIC_API_BASE_URL="<base-url-of-deployed/local-api>/api"
    
    # Manage Testnets, if true westend will be enabled
    NEXT_PUBLIC_TESTNETS_ENABLED=true
    
    # Network Endpoints
    NEXT_PUBLIC_POLKADOT="wss://polkadot.api.onfinality.io/public-ws"
    NEXT_PUBLIC_KUSAMA="wss://kusama-rpc.polkadot.io"
    NEXT_PUBLIC_WESTEND="wss://westend-rpc.polkadot.io"

    Note: Checkout backend crawler and api.

    Useful resources:

  • Run the development server:

    Note: Make sure api and crawler services are up and running

    yarn dev

    Open http://localhost:3000 with your browser to see the result.

    You can start editing any page by modifying pages/<page>.js. The page auto-updates as you edit the file.

  • Creating a new user flow?

    • Create a new page in pages/<page>.js
    • Create a layout if needed in components/common/layouts else use components/common/layouts/base.js
    • Create the page's root component in components/<page>/index.js

Git commit

Run yarn git:commit for commiting your code and follow the process

Learn More

To learn more about Next.js, take a look at the following resources:

Docker

You can run a docker container via -

docker run -p 3000:3000 -e NEXT_PUBLIC_API_BASE_URL=<base-url-of-deployed/local-api> -t yieldscan-frontend

after running you can access the UI via http://localhost:3000

Tests

You can run tests via -

yarn test

Gratitude

About

Maximize your yield on staking with YieldScan. Scanning yield on nominated proof-of-stake networks. Supported Networks: Polkadot and Kusama.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages