https://github.com/musakui/fedi

tools for the fediverse
https://github.com/musakui/fedi

activitypub

Last synced: 24 days ago
JSON representation

tools for the fediverse

• Host: GitHub
• URL: https://github.com/musakui/fedi
• Owner: musakui
• License: mit
• Created: 2022-05-03T11:21:05.000Z (over 2 years ago)
• Default Branch: omo
• Last Pushed: 2023-03-22T12:21:26.000Z (over 1 year ago)
• Last Synced: 2024-05-23T04:04:38.191Z (6 months ago)
• Topics: activitypub
• Language: JavaScript
• Homepage:
• Size: 59.6 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fedi

> tools for the fediverse

[![npm](https://img.shields.io/npm/v/@musakui/fedi.svg)](https://www.npmjs.com/package/@musakui/fedi)

**Warning** this is still experimental and APIs are expected to change a lot

This project houses the low-level interfaces to interact with the Fediverse. It aims to be

- buildless (ESM)

- isomorphic (run in browser and Node)

- typed (with [JSDoc](https://jsdoc.app) annotations and TS declarations)

Documentation will be lacking, so please refer to [kotori](https://github.com/musakui/kotori) for usage examples.

## Modules

These are the main components. Please suggest more if you think they should be added.

### [ActivityPub](https://activitypub.rocks) (and ActivityStreams)

The core protocol for federated social networking. For a quick rundown, this [highly opinionated guide to learning about ActivityPub](https://tinysubversions.com/notes/reading-activitypub) is highly recommended.

Similar libraries

- [michaelcpuckett/activitypub-core](https://github.com/michaelcpuckett/activitypub-core)

- [activitypub-js/activitypub-types](https://github.com/SiranWeb/activitypub-types)

### `.well-known` endpoints

Some [Well-known URIs](https://en.wikipedia.org/wiki/Well-known_URI) have been defined for easy communication between services. The main ones are [WebFinger](https://webfinger.net) (to lookup handles) and [NodeInfo](https://github.com/jhass/nodeinfo) (server metadata).

### HTTP Signatures (and Keys)

To verify messages across services, HTTP requests are signed with keys.

**Note** There is some code for hs2019 but take note that it is not well supported