pump-io / pump.io Goto Github PK

View Code? Open in Web Editor NEW

2.2K 140.0 333.0 12.03 MB

Social server with an ActivityStreams API

Home Page: http://pump.io/

License: Apache License 2.0

JavaScript 97.32% CSS 0.78% Shell 0.14% HTML 0.37% Dockerfile 0.03% Pug 1.36%

federation javascript social-network decentralization nodejs social activitystreams pump-io

pump.io's Introduction

pump.io

This is pump.io. It's a stream server that does most of what people really want from a social network.

What's it for?

I post something and my followers see it. That's the rough idea behind the pump.

There's an API defined in the API.md file. It uses activitystrea.ms JSON as the main data and command format.

You can post almost anything that can be represented with activity streams -- short or long text, bookmarks, images, video, audio, events, geo checkins. You can follow friends, create lists of people, and so on.

The software is useful for at least these scenarios:

Activity stream functionality for an existing app
Experimenting with social software

It also comes with a web UI.

Documentation

For information about project policies please check out the GitHub wiki, and for technical documentation see our ReadTheDocs website.

Bugs

If you find bugs, you can report them here:

https://github.com/pump-io/pump.io/issues

Colophon

This software includes the following great packages of client-side software.

Twitter Bootstrap
Backbone
JQuery
Fine Uploader
WysiHTML5
Spin.js
SockJS
Select2
JQuery Easydate
OAuth.js

It also uses these icon sets:

Fancy Avatars, © 2009 Brandon Mathis, http://brandonmathis.com/projects/fancy-avatars/ (CC-By)
Font Awesome by Dave Gandy, http://fontawesome.io/ (SIL Open Font License 1.1)

This sample photo is used for the main page:

http://www.flickr.com/photos/makelessnoise/240072395/ (CC-by)

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

pump.io's People

Contributors

Stargazers

Watchers

Forkers

eschnou julien-c atd jamon8888 robertvisser qray reality mscherer sqawasmi ocasta nizaranand sandroid828 fmarier johndrinkwater bouska rayleyva lemonhall shtrom mrvdb macno fil air4ee psquid frankk00 reregistered blaine mathnerd314 ipublicis larjona jasonbogovich sagaienet nzinfo grdryn warpr tekktonic monkongossa szenekonzept csolisr obra afei418 sammyleigh equipote prodigeni shaopenghe haebin ryanj jfrobbins xizdev maelstrom168 everlive markjaroski cesine marlncpe richardfontana feedstream todb-r7 thinq4yourself psibi joeboy melinite kalayl shaohua kidpollo t1c1 imclab izunia man27382210 drdougtheman tastycode screwtapello miguelramosfdz fredericksilva emav pixelpark agilee martindale mercurymod evervary akshayagarwal liamzebedee pombredanne bcomnes computingfreak nj3ma zimamedia dgoodwin kevikoech muratmeran matzegebbe kabniel genba psyde22 opensocial msjoberg digital-dreamer mgebbe jefcarlier turtledb web5design procod3r

pump.io's Issues

REST endpoint for list of likers of an object

We should have a REST API endpoint for the list of people who've liked an object.

Avatars

We should allow the user to upload an avatar picture.

Show an error when login fails

Because that's just lame.

Support 'organization' activity object type

The Social Web is not federated

Social networks are isolated and disconnected. People put their creative works, their social graph, and their personal connections into services with dubious terms of service. Service providers depend on the network effect to prevent healthy competition. Gigantic user databases are a one-stop-shopping target for hackers and spy agencies.

We must federate the social web.

Support 'task' activity object type

Navigation links for user followers list

first, last, next

Edit profile

Users should be able to edit their own profile.

This should be reflected in the 'person' object.

Comments in Web UI

We should allow posting comments in the Web UI, and showing posted comments.

Support 'alert' activity object type

REST endpoint for list of favorites

We should have a REST API endpoint for the user's favorites.

OAuth for API

We should support OAuth access to the API.

Allow POST to following list

A user should be able to POST to their own following list to follow someone new.

It should generate a new 'follow' activity, also.

Allow POST to favorites list

We should allow a POST by the user to their own favorites list.

It should generate a 'favorite' activity.

OAuth for remote login in Web UI

You should be able to log into a remote site using OAuth.

Once you're logged in, you should be able to generate activities related to that site: comments, faves, follows, and shares.

Dynamic client registration

We need dynamic client registration, as in http://openid.net/specs/openid-connect-registration-1_0.html

Post note in Web UI

We need a posting interface in the Web UI.

Initially it should let you post a note (text). Maybe with Markdown.

REST endpoint for list of lists owned by a user

We need a lists collection endpoint.

Activity lists in Web UI

We need to show activities in lists in the Web UI.

It's probably a good idea to have a "default" activity view, then specialized views by the verb and object of the activity.

For example, "post" a "note" would have a special view; "share" an "activity" might have a different view. "follow" a "person" would have a different view.

OStatus

We should support remote follow using OStatus.

Follow in Web UI

It should be possible, when viewing someone's profile page, to follow them.

Support 'application' activity object type

Support 'process' activity object type

Support 'device' activity object type

Support 'binary' activity object type

Post image in Web UI

We need a way to upload an image in the Web UI.

We may want to support folders or images.

Handle 'favorite' verb

An activity posted with the 'favorite' verb should:

Add the object to the user's list of favorites
Add the user to the list of people who like that object

Publish activity outbox with socket.io

Use socket IO to publish activity streams.

Restricted posts

You should be able to restrict audience for a post by including an address.

Standard addresses: public, followers, site, ...?

Other addresses: people, groups, lists.

Support 'game' activity object type

Webfinger

We need Webfinger.

First, for OStatus stuff.

Also, for discovering a user's feed, and their inbox.

Support new activity verbs

There are a whole bunch of new activity verbs at http://activitystrea.ms/specs/json/schema/activity-schema.html . We should support them all.

Navigation links for user feeds

Include navigation links for user feeds: first, next, prev.

Following list

List of people a user is following. API and Web UI.

Follower list

List of a users followers. API and Web UI.

Lists

We should support lists (user-curated collections of other users).

Registration UI

UI to register a new user

Conversation stream

Use roll-up version of activities to show a conversation-oriented stream.

http://activitystrea.ms/specs/json/replies/1.0/#stream

Show likes for activity objects

I think we should show the likes responses for an activity object in these cases:

If it's the object of an activity
If it's being returned directly from the REST API

Favorite in Web UI

We should support favoriting an object in the Web UI.

Scalability level 0

I'm interested in seeing this project make scale a priority.

So, here's my first scalability goal: consider a network of 100,000 users. There is a Pareto distribution of number of followers per user, with an 80-20 rule distribution (good enough) and an expected value of the Dunbar number, 150. See http://en.wikipedia.org/wiki/Pareto_distribution for help on this.

The scalability goal is to handle 10 new activities per second (aps) with a maximum delivery time of 100 seconds.

In the future, we can vary the numbers by orders of magnitude (100 aps, 10^6 users, 10s for delivery) to reach higher goals.

There may be some options to archive old stream members, so a "stream" might consist of a "current" stream list plus many, many "archive" stream lists.

When they're the object of an activity (Activity.expand() should handle this)
When they're returned directly

This should probably just be added to ActivityObject.expandFeeds()