jusdy/Web3Assignment

Assignment for blockchain with Swagger Documentation - Node.js Project

Welcome to the My Assignment This Node.js application utilizes the ethers.js library to interact with Ethereum-based blockchains and provides an easy-to-use Swagger documentation interface for exploring the available APIs.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Usage

Getting Started

Follow these instructions to get the project up and running on your local machine.

Prerequisites

• Node.js (v14.17.4 recommended)
• Yarn (v1.22.11 recommended)

Installation

1. Clone the repository:

   git clone https://github.com/jusdy/Web3Assignment.git
   

2. Navigate to the project directory:

   cd Web3Assignment

3. Install the project dependencies using Yarn:

   yarn install
   

Usage

1. Start the development server:

   yarn dev
   

2. To explore the available APIs and their documentation, open your web browser and go to:

   http://localhost:8000/docs
   

The Swagger UI interface will allow you to interact with the APIs in a user-friendly manner.