Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 1.88 KB

README.md

File metadata and controls

93 lines (64 loc) · 1.88 KB
Raw

activitypub.js

An opinionated, practical and useful implementation of the ActivityPub spec

WARNING, this is VERY early stage and doesn't work yet.

Goals

  • Fully interoperable with existing ActivityPub implementations (e.g. Mastodon)
  • Complete, covering Client to Server and Server to Server
  • Well tested
  • Vanilla and opinionated
  • Includes applied security best practices
  • Straightforward to drop in to another node app or bootstrap from
  • Full federation support

What does this do?

Running this application will give you an application API that supports all of the standard ActivityPub requirements for a full social app including WebFinger, ActivityPub, ActivityStreams, Actors, Authentication and basic app features. You can then extend or modify this to create pretty much any social application you can think of.

See [some examples](##Try It) of what you can do out of the box.

Stack

  • node v8.4.0+
  • Postgres
  • Typescript
  • TypeOrm
  • Express
  • Pino
  • Mocha
  • Swagger
  • ...

Setup

Install It

  • Clone this repo
  • Install node, npm and postgres
cd activitypub.js
npm install

Configure it

  • Adjust the .env file with your specific defaults. We use some sensible defaults but you can use whatever you like
  • Don't forget to create a database in postgres (default is activitypub)

Run It

In development mode:

npm run dev

In production mode:

npm run compile
npm start

Test it

npm run test

Debug it

npm run debug

Then open chrome://inspect/#devices in Chrome and click on Remote Target

Deploy to the Cloud

e.g. CloudFoundry

cf push activitypub.js

Try It

  • Point your browser to http://localhost:3000
  • Invoke the example REST endpoint curl http://localhost:3000/.well-known/webfinger

Example endpoints

  • /.well-known/webfinger?resource=acct:test@domain.com