Code Monkey home page Code Monkey logo

activitypub.js's Introduction

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

activitypub.js's People

Contributors

pauljohncleary avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.