Giter VIP home page Giter VIP logo

irys-provenance-toolkit's Introduction

Provenance Toolkit

Provenance toolkit video

The Irys Provenance Toolkit is a collection of UI components you can use to kickstart your next application. It contains UI components for managing node balances, uploading files, performing gassless uploads, and querying transactions.

The toolkit is fully open source, you are welcome to use it any way you want with or without attribution.

Docs

For details on how to use (and customize) each component, refer to our docs.

Demo

You can interact with the provenance toolkit at https://provenance-toolkit.irys.xyz

Prerequisites

The Provenance Toolkit is designed for intermediate to advanced developers and assumes you have a working knowledge of NextJS, TypeScript, and Tailwind. Beginning developers may want to start with our tutorials and quests which are designed for a broader audience.

Setup

  1. Fork or clone https://github.com/Irys-xyz/provenance-toolkit
  2. Run npm install or yarn from within the project directory
  3. Rename .env.local.example to .env.local and follow the configuration instructions in that file
  4. Run npm run start from within the project directory
  5. Launch the Provenance Toolkit at http://localhost:3000/

Project layout

Toolkit layout

The project is broken into three main categories:

  • Components: The UI components. These can be added to your project and used as is.
  • Navigation routes: NextJS navigation routing. If you’re building your own project on top of the Provenance Toolkit, you can delete these routes and create your own.
  • Utils: Utility functions used by the UI components.

These are further detailed in our docs.

Components

Included within the Provenance Toolkit are the following components:

Fund / withdaw

Manage node balances.

Toolkit layout

Uploader

Upload single files or groups of files.

Toolkit layout

Progress bar uploader

Upload large files, and provide feedback with a progress bar.

Toolkit layout

UDL uploader

Upload files and attach a UDL.

Toolkit layout

Gassless uploader

Pay for user uploads server-side.

Toolkit layout

Transaction feed

Query Irys transactions.

Toolkit layout

irys-provenance-toolkit's People

Contributors

lukecd avatar theholtz 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.