Giter VIP home page Giter VIP logo

hashboard's Introduction

Zettahash Hashboard Frontend

Hashboard Application

Preview Builds

Deployment Badge

The Zettahash Hashboard Frontend is a crucial component of the Zettahash DAO, designed to ensure transparency and accessibility of project information for users. This frontend provides comprehensive data on financials, computational power, hashrate, profitability, market trends, tokenholder statistics, governance proposals powered by Snapshot, and communication channels.

Table of Contents

Project Setup

We utilise Vite for frontend tooling.

Prerequisites

  • Node.js v20

Installation

Install dependencies with:

npm install

Development

Compile and hot-reload for development:

npm run dev

Production

Compile and minify for production:

npm run build

Linting

Lint and fix files:

npm run lint

Configuration

See the Vite Configuration Reference.

Environment Configuration

Specify the backend server in your .env file. You can choose between a local server or the main full server.

Example .env file:

# Set to 'locallost' for local backend server or 'https://zettahash_hashboard_middleware.zetta-735.workers.dev' for the main full server
VITE_MIDDLEWARE_URL=http://localhost:3000

Development Journal

This section documents ongoing changes and features of the Hashboard. Note that the organisation of this document will evolve over time.

Hashboard Ethos

The Hashboard is committed to providing transparent access to Zettahash operational data and financials for investors and shareholders, adhering to Zettahash DAO policies.

Features

Data Views

  • Linecoin mining data graphs and information tiles
  • Ocean mining embedded dashboard
  • Dextools market graphs and exchange links for ZH on dextools.io
  • ETH, ZH, USDT, BTC core wallet balances
  • Hedgey vesting details for core wallets
  • User wallet balances, ENS viewing, and disconnect options
  • Snapshot spaces and proposals

Communication

  • Reddit-style forum
  • Link to Discord server
  • Link to Telegram group

Interaction

  • Purchase ZH (Beneficiary)

Implementation TODO

  • Cast votes on proposals directly from the Hashboard
  • View connected wallet vesting details
  • Create a dashboard with real gauges and graphs (for demonstration purposes)

Contribution Guidelines

We welcome contributions to the project. Please follow these steps for a smooth contribution process:

  1. Fork the Repository: Fork the repo to your GitHub account.
  2. Push Changes to Your Fork: Implement your changes in the forked repository.
  3. Create a Pull Request: Submit a PR to the main repository.
  4. Discuss Changes in Consensus Chat: Engage in discussions about the changes.
  5. Proposal on Snapshot: Create a detailed proposal on Snapshot outlining the changes and objectives for merging the branch.

Dispersed Log

This log chronicles significant changes across the ZH technical framework.

  • CDN: Updated Zettahash DAO Token symbol name for add-to-metamask function
  • Hashboard components built after April 2024 should use Composition API
  • Frontend tooling upgraded to Vite

License

This project is licensed under the MIT License. See the LICENSE file for more information.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contact

For questions or support, please contact the Zettahash team at [email protected].

Thank you for using Zettahash Hashboard!


This README file was last updated on 24 June 2024.

hashboard's People

Contributors

vswee 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.