Giter Club home page Giter Club logo

distributed-storage's Introduction

Distributed Storage

Distributed storage CLI implementation leveraging IPFS and Ethereum chain

Table of Contents

Features

file-upload-help

  • Upload any file to IPFS and store its cid in the smart contract file-upload-help

  • List all already uploaded files file-list-help

Environment Setup

Pre-requisites

  • Node.js installed locally (version 18 or higher).
  • IPFS node running locally. Setup instructions can be found here.
  • Ganache running locally. Setup instructions can be found here.

Build instructions

  • Clone the repository
  • Install dependencies
    • npm i
  • Deploy smart contract
    • npm run deploy-contract
  • Build cli application
    • npm run build-cli

Example

File upload

  • File can be uploaded using the upload command. Make sure the cli is built, and the smart contract is deployed before running the command. Command will prompt for the Ethereum account private key. Private key can be read from ganache UI (In the top menu select Account and press on the key icon on the right).
    • npm run cli upload <path_to_file> (eg. npm run cli upload ./doc-images/file-upload-example.png)

file-upload

File list

  • List uploaded files. Only the files uploaded by the selected account are listed.
    • npm run cli ls

file-upload

distributed-storage's People

Contributors

acuderman avatar

Watchers

 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.