Skip to content

👩‍🎤 Headless, type-safe, UI components for the next generation Web3.Storage APIs.

License

Notifications You must be signed in to change notification settings

w3s-project/w3ui

Repository files navigation

Web3.Storage UI logo

Headless, type-safe, UI components for the next generation Web3.Storage APIs.

GitHub Workflow Status License: Apache-2.0 OR MIT

This repo contains reusauble UI modules for the web3.storage w3up service in React and vanilla JavaScript, and a set of example apps to see them dance.

Documentation

The documentation at beta.ui.web3.storage is currently out of date - updates coming soon!

API

API Reference

Examples

  • Sign up / Sign in React

    Demonstrates email authentication flow for the service, including private key creation and email validation.

  • Single File Upload React

    The simplest file upload using a file input. Includes the auth flow from "Sign up / Sign in".

  • Multiple File Upload coming soon! React

    Slightly more complicated file and directory upload. Includes the auth flow from "Sign up / Sign in".

  • Uploads List coming soon! React

    A demo of the list of uploads that have been made to an account.

Contributing

Feel free to join in. All welcome. Please read our contributing guidelines and/or open an issue!

Getting started

To contribute to this project, clone the w3ui repository and enter the w3ui directory

git clone https://github.com/web3-storage/w3ui
cd w3ui

Install dependencies and build:

pnpm install

Then pick an example app from the list, cd into it's directory and run pnpm start to try it out.

License

Dual-licensed under MIT + Apache 2.0