Skip to content

Latest commit

 

History

History

fig

README.md

We used fig to build canopy.banyan.sh, our live frontend for the Canopy social network. Check it out!

Overview

Fig is React hooks for xmtp, brpc, banyan, and Canopy With fig you can comopse applications using open data protocols.

Features

fig is hooks for...

XMTP

The xmtp-js SDK allows you to send, receive, and subscribe to XMTP conversations. fig provides a set of ergonomic hooks for working directly with xmtp-js.

brpc

fig provides hooks to access any live brpc backend but works best when paired with a published typesafe API. Learn more about how to build and publish brpc APIs here.

Banyan

Banyan is a key-value server for XMTP. You can use Banyan to build open data protocols. fig provides hooks for Banyan's entire API.

Canopy

Canopy is a completely open social network powered by Banyan and XMTP. With fig you can add social networking features to your app with just a few lines of code.

We used fig to build canopy.banyan.sh, our live frontend for Canopy!

Contents

Documentation

Quick Start

TODO More here.

npm install @killthebuddh4/fig

Usage

We've "inlined" basic working use cases with each public hook. You can see each use case live at https://fig.banyan.sh/examples/name-of-hook.

TODO List the API here.

API Reference

TODO For each hook, it's signature and basic usage, notes, and gotchas.

Support

The best place to get real-time support is the #banyan channel in Discord. You'll get extra special attention and tons of kudos 🎉 if you also open an issue.

Community

  • Join us on Discord 💬
  • Follow Achilles on Twitter for project updates 🤝

Contributing

If you're interested in contributing, please read the contributing docs before submitting a pull request.

Sponsors

You can be the first ❤️!

Authors

License

MIT License

Roadmap (& Notes)

  • stateful worker hooks
  • action worker hooks
  • unifying hooks
    • useLogin
    • useConversation
    • useMessages
    • useInbox (TODO)
  • helper hooks
    • useCreateConversation
    • useSendMessage
    • ...
  • brpc hooks
  • banyan hooks
  • ...