fediverse
/
activity-kit-core
mirror of https://github.com/michaelcpuckett/activity-kit.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
An attempt to build a spec-compliant ActivityPub core library.
267 Commits 4 Branches 515 Tags 7.3 MiB
TypeScript 68.1%
JavaScript 31.9%
Go to file
Michael Puckett 9464725f80 update checklist 2022-10-26 19:20:32 -04:00
packages v0.0.147 2022-10-26 17:03:21 -04:00
.env Rework activitypub-core-types src 2022-10-11 08:26:07 -04:00
.gitignore Remove lerna-debug 2022-10-24 11:28:50 -04:00
CHECKLIST.md update checklist 2022-10-26 19:20:32 -04:00
CONTRIBUTING.md notes 2022-10-19 16:57:46 -04:00
LICENSE fix sharedInbox 2022-10-14 21:47:00 -04:00
README.md readme 2022-10-26 17:11:43 -04:00
TODO.md fixup 2022-10-24 11:27:44 -04:00
lerna.json v0.0.147 2022-10-26 17:03:21 -04:00
package-lock.json v0.0.147 2022-10-26 17:03:21 -04:00
package.json add eslint 2022-10-14 22:32:58 -04:00

README.md

activitypub-core

This is a Lerna monorepo that holds packages related to an implementation of the ActivityPub protocol specification.

ActivityPub is a standardized method of exchanging social data.

Current Status

This is a toy project at the moment. It's not fully working and it changes frequently.

See TODO.md and CHECKLIST.md.

Running in a Project

Canonical example using Firebase Auth, Express, MongoDB, JSX:

(async () => {
  const app = express();
  const authenticationService = new FirebaseAuthentication(serviceAccount, '<project-id>');
  const databaseService = await new MongoDatabaseService().connect({
    mongoClientUrl: 'mongodb://localhost:27017',
  });
  const deliveryService = new DeliveryService(databaseService);

  app.use(
    activityPub(
      {
        renderIndex: async () => {
          return `
        <!doctype html>
        ${renderToString(<IndexPage />)}`;
        },
        renderEntity: async ({ entity, actor }) => {
          return `
        <!doctype html>
        ${renderToString(<EntityPage entity={entity} actor={actor} />)}
      `;
        },
        renderHome: async ({ actor }) => {
          return `
        <!doctype html>
        ${renderToString(<HomePage actor={actor} />)}
      `;
        },
      },
      {
        authenticationService,
        databaseService,
        deliveryService,
      },
    ),
  );

  app.listen(process.env.PORT ?? 3000, () => {
    console.log('Running...');
  });
})();

General Philosophy

This project aims to be spec-compliant.

This project aims to be an non-opinionated as possible, providing abstracted layers that can hopefully work with any Node.js project.

This project is MIT-licensed, with the hope it will be forked, reused, or wholly included in other projects due to this permissive license. There may be similiar software that exists, but inclusion would be inviable due to licensing restrictions.

Use Cases

There are a few use cases this project attempts to fulfill. Ideally this project papers over some of the complexity of JSON-LD, Activity Streams collections, etc. to make getting started easy.

Connecting a Blog to the Fediverse

Someone already has an HTML blog and a domain name and wants their posts to be read by others and get replies. Instead of setting up a CMS, they decide to set up an ActivityPub server.

Single-Server Social Feeds

An exercise app wants to build in social features to make their users feel proud of their achievements. This would probably include something like a notification bell and a feed where updates about their friends appear. Users might have with the option to react with an emoji or sticker.

All these exchanges would stay local to the server.

Private Group Chat

A small group of people who communicate online become dissatisfied with their existing app's policies and decide to communicate privately. They would like to develop their own system for communication.

Although ActivityPub does not define an encryption layer, messages could stay local to a single server or could be exchanged between all parties in an ephermeral way. Encryption could be a good addition, however.

Federated Social Network

Ideally this project could be used to build an entire social network that interfaces with the rest of the Fediverse.

Architecture

This project aims to be agnostic as to how the data is stored, which server is used, etc. Plugins/adapters that conform to a specific interface can be mixed and matched.

Logic Layer

The logic layer that get included in all projects include these packages:

  • activitypub-core-types
    • The Activity vocabularies converted to TypeScript types.
  • activitypub-core-endpoints
    • The logic for carrying out the bulk of the ActivityPub protocol.
  • activitypub-core-delivery
    • The logic specific to the Server-to-Server delivery (federation).
  • activitypub-core-utilities
    • Common functions with no dependencies on packages from upper layers.

Database Layer

Currently this project comes with:

  • activitypub-core-mongodb
  • TODO: PostreSQL

Authentication Layer

Current this project comes with:

  • activitypub-core-firebase-auth
  • TODO: Passport.js

Storage Layer

Currently this project comes with:

  • activitypub-core-ftp-storage
  • TODO: AWS S3, Firebase Storage

Server Layer

Currently this project comes with:

  • activitypub-core-express-middleware
  • TODO: Fastify, Next.js

Client/Rendering Layer

TBD. Currently using JSX (React) server-side.