Skip to content

A very simple block explorer created with Vanilla TypeScript, leveraging the Web3.js library and Browser Injected API. Student project @Medieinstitutet.

License

Notifications You must be signed in to change notification settings

alcompilor/blockio

Repository files navigation

👋 Overview

Blockio is a basic web application developed using Web3.js and the Browser Injected API (wallet-injected API). It is crafted to enable smooth interaction with Ethereum Virtual Machine (EVM) blockchains. Whether you're a developer, researcher, or blockchain enthusiast, Blockio offers a user-friendly interface for executing key operations on EVM blockchains.

Overview of Blockio

💻 Tech Stack

  • HTML / SASS
  • TypeScript
  • Vite
  • Web3.js
  • Injected Web3 API

🌟 Features

  • Get Current Block Quickly retrieve the number of the latest block in the blockchain.
  • Check Balance Check the balance of any Ethereum account with ease. Simply input the account address, and Blockio will fetch and display the current balance.
  • Transfer Funds Initiate secure fund transfers between Ethereum accounts. Blockio streamlines the process of sending funds, allowing users to specify the recipient's address and the amount to be transferred.

⚠️ Requirements

Before you get started with Blockio, make sure you have the following prerequisites installed:

  • Node.js (v20.10.0 or newer)
  • npm (Node Package Manager)
  • Ports 4173 & 5173 must be available

🚀 Installation

  1. Clone the Blockio repository:
    git clone https://github.com/alcompilor/blockio.git
  2. Navigate to the project directory:
    cd blockio
  3. Install the dependencies:
    npm install
  4. Build the application:
    npm run build
  5. Start the application:
    npm run preview
  6. Open your browser and go to http://localhost:4173 to access Blockio.

🧪 Unit Tests

Blockio uses Vitest as its testing framework. To execute the existing tests, ensure that you have installed the required dev dependencies and then run the following command:

   npm test

Adding Tests

If you wish to contribute or introduce new tests, locate the existing test files in the tests directory. Adhere to Vitest testing conventions and create your test files accordingly.

⚖️ License

Blockio is licensed under the MIT License. Feel free to reach out if you have any questions or suggestions.