IPFS Upload button

Customable Web Component button to upload files to IPFS.

Technology Stack

• Typescript - Programming language used to develop the project.
• Web Components - To build and provide cross-browser support for the component.

IPFS providers & pining services

• Web3Storage - As IPFS provider and pinning service.
• Pinata - As IPFS provider and pinning service.

Usage & Installation

• install NPM package npm install @fazio/ipfs-upload-button
• import the component in your project import '@fazio/ipfs-upload-button'
• provide valide APIKEY. See doccumentation:Config section for more details.
• add the component to your HTML page

  <web3-upload-btn token="YOUR_APIKEY">
    Upload to IPFS
  </web3-upload-btn>

Documentation

• Doc Reference
• Usage with Angular
• Usage with React
• Usage with Javascript

Development

• Clone repository
• Install dependencies using NodeJS and NPM
• Install Nx Workspace CLI to manage workspace project
• Run developpment server using nx serve command will open the application in the browser
• This project was generated using Nx Workspace.

Publish

You have to build and bundle the project before publishing it to NPM.

• Run npm run publish to build and publish the project to NPM registry.

Architecture overview

The follder architecture is based on Nx Workspace to provide a configurable workspace that can contain multiple applications in the ./apps folder and multiple libraries in the ./packages folder. This is very useful for building large scale applications with multiple components and features that can be easily maintained and updated.

• The main package is stored in ./packages/ipfs-upload-button folder and it contains files and folders that are required to build the library.
• The Documentation website is stored in ./apps/docs folder and it contains files and folders that are required to build the documentation website.

You can find demo applications in the ./apps folder that are used to test the library and to provide examples of how to use the library in different frameworks like Angular, ReactJS or Vanilla Javascript.

Contributing

Thanks for taking the time to help out and improve the project! 🎉

The following is a set of guidelines for contributions and may change over time. Feel free to suggest improvements to this document in a pull request!

See CONTRIBUTING.md

License

Project is Open Source and available under the MIT License.

Team

• @fazionico - Nicolas Fazio

  Software Architect & Blockchain Developer

  Mr. Fazio is a software architect and blockchain developer with over 15 years of industry experience. He has worked on a variety of projects ranging from cloud enterprise software to blockchain applications focusing last 3 years exclusively in the Web 3 industry. He is passionate about building decentralized solutions and is currently working on Web3 projects.

  LinkedIn: https://www.linkedin.com/in/fazio-nicolas/

Support

If you like this project, please consider supporting it by giving a ⭐️ on Github and sharing it with your friends!