Skip to content

Latest commit

 

History

History
127 lines (76 loc) · 3.4 KB

README.md

File metadata and controls

127 lines (76 loc) · 3.4 KB
Raw

ZKchainHub UI 🌐

Description

The ZKchainHub proposes a decentralized, permissionless platform that provides custom analytics dashboards for ZK ecosystems, empowering chain operators to track and visualize key metrics like TVL, transaction counts, and block details. This allows users to easily explore each chain.

📋 Prerequisites

  • Ensure you have pnpm >= 9.0.0 installed.

💻 WebFlow

The flow of the application is as follows:

Home Page: The ecosystem page, where data is fetched from metrics/ecosystem. From here, you can navigate to all token's TVL data or directly to the Chain Page.

Chain Page: Accessible via search in the header or by selecting a row in the table. Information is fetched from metrics/zkchain/:id.

🚀 Installation

$ pnpm install

⚙️ Setting up env variables

  • Create .env file in the root folder and copy paste .env.example content in there.
$ cp .env.example .env
  • Set up NEXT_PUBLIC_API_BASE_URL with ZKchainHub Backend API url. It will typically run on http://localhost:3000
  • (Optionally)
    • Set NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID with your Wallet Connect ProjectID
    • Set NEXT_PUBLIC_TESTNET_MODE with true to use testnet mode with testnet backend API URL set up in NEXT_PUBLIC_API_BASE_URL

🏃 Running the app

$ pnpm run start

To verify ZKchainHub UI is running open http://localhost:5173 in your browser

Deployment

🏗️ Vercel deployment

Prerequisites

  1. Vercel Account: Sign up if you don’t have an account.

  2. Vercel CLI: Install the Vercel CLI by running:

    npm install -g vercel

Deployment Steps

  1. Authenticate with Vercel: Run the following command and follow the prompts to log in

    vercel login

  2. Deploy Your Project: Navigate to your project directory and run:

    vercel

Follow the prompts to configure your project. Vercel will automatically deploy your project and provide a live URL.

  1. Set Environment Variables: To add environment variables, use:

    vercel env add <name> <value>

Additional Resources

🐳 Docker deployment

Prerequisites

  • Docker: Ensure that Docker is installed.

Deployment Steps

  1. Build the Docker Image

    From your project directory, build the Docker image by running the following command:

    docker build -t <app-name> .

  2. Run the Docker Container

    After the image is built, run the Docker container with the environment variables.

    docker run -p 5173:5173 --env-file .env <app-name>

  3. Access your app:

    http://localhost:5173

Development

💻 Conventional Commits

We follow the Conventional Commits specification.

Contributing

ZKchainHub was built with ❤️ by Wonderland.

Wonderland is a team of top Web3 researchers, developers, and operators who believe that the future needs to be open-source, permissionless, and decentralized.

DeFi sucks, but Wonderland is here to make it better.