📄 | README.md |
📄 | earthsea.jpg |
Scuttlebutt Guide
Looking to learn how to build in Scuttlebutt? There's currently no canonical resource, but here's a map of the known archipelago!
Have you found an Uncharted Isle? We'd love to hear about it.
Documentation
scuttlebot.io - has great details about sbot and ssb-client (and other modules)
ssbc.github.io - a predecessor to scuttlebutt.io, much of the same content, has some other tutorials
pull-stream.github.io - a guide to the pull-stream ecosystem (scuttlebut uses pull-streams extensively)
github.com/pull-stream/pull-stream-faq - a simple FAQ
Tutorials
Videos
Intro to Scuttlebutt
- ssb-client - repo + video (ssb | github), learn how to connect to your databaseand do some streaming queries!
Into to Mutant
- Part 1 - video, introduces observeables with
Value
, andwhen
. Make a part of the page toggle dynamically - Part 2 - video, introduces
computed
which takes in multiple observeables and makes a new observeable, andStruct
(kind a like an observeable object with pre-defined keys). I focus a bit of refactoring and moving code around to give you an idea of what's possible.
Mutant is a client side reactive library which is all about mutating the DOM. It's used by Patchwork, Patchbay, Ticktack (and the underlying lib Patchcore).
Written
github.com/don-smith/ssb-tutorial - a command line intro that uses docker to spin up several sbots and get them talking to each other.
Code snippets
scuttlebot.io - lots of code snippets, some background
- post a message
- watch for new messages
- publish a blob | read a blob (blobs are files / attachments)
- many others
ssbc.github.io/scuttlebot/ - (see HowTo Guides down side) more detail, but an odler reference
- post a message (includes examples of mentioning, channels etc.)
- update your profile
- example of mentioning blobs in a post
- set up a Pub Server manually (an old guide)
Module guides
scuttlebutt.nz/modules.html - a great overview of modules organised by domain / stack-position
Built with git-ssb-web