ytchev/pepyatka

Open source FriendFeed clone.

Pepyatka

Pepyatka is another attempt to open source FriendFeed social network/aggregator. At this stage it's a semi-anonymous imageboard.

Configuration

• Install redis
• Install graphicsmagick (ensure jpeg and png flags are set)
• Install nodejs
• Install elasticsearch (and java as a dependency ;-)
• Install forever: npm install -g forever
• Make sure to update secret token: cp ./conf/envDefault.js to ./conf/envLocal.js.
• Install dependencies: npm install
• Update translation file: cp ./public/config/envDefault.js ./public/config/envLocal.js
• Check there are no broken tests: jake test
• Run elasticsearch
• Run server: node ./server.js
• Run search daemon: node ./bin/search-daemon.js

Roadmap

Tasks: https://trello.com/b/uvRkkOTH

Database

username:<username>:uid

type is a enum of set of { "user", "group" } # not implemented yet

user:<userId> { username, hashedPassword, salt, createdAt, updatedAt, type }
user:<userId>:timelines { RiverOfNews, Posts, Likes, Comments, DirectMessages, [name*] }
user:<userId>:administrators { <userId>:<timestamp> } # not implemented yet
* DirectMessages not implemented yet
* Custom lists not implemented yet
user:<userId>:subscriptions ( <timelineId>:<timestamp> )

reserved usernames:
- anonymous
- everyone

timeline:<timelineId> { name, userId }
timeline:<timelineId>:posts ( <postId>:<timestamp> )
timeline:<timelineId>:subscribers ( <userId>:<timestamp> )

as special case there is timeline: timeline:everyone

post:<postId> { body, createdAt, updatedAt, userId, timelineId }
post:<postId>:comments [ <commentId> ]
post:<postId>:attachments [ <attachmentId> ]
post:<postId>:timelines ( <timelineId> )
post:<postId>:likes ( <userId> )

comment:<commentId> { body, createdAt, updatedAt, createdBy, postId }

attachment:<attachmentId> { mimeType, filename, extension, path, createdAt, updatedAt, postId, thumbnailId? }

stats:<userId> { posts, likes, discussions, subscribers, subscriptions }
stats:posts { <userId>:<posts> }
stats:likes { <userId>:<likes> }
stats:discussions { <userId>:<discussions> }
stats:subscribers { <userId>:<subscribers> }
stats:subscripions { <userId>:<subscriptions> }

tags:<userId> { <tag>:<score> } # implemented only for everyone, see below

as special case there are tags: tags:everyone

API

Timeline

• GET /v1/timeline/:username - returns all posts from user
• GET /v1/timeline/everyone - returns all posts from everyone
• GET /v1/timeline - returns river of news for auth user
• POST /v1/timeline/:timelineId/subscribe
• POST /v1/timeline/:timelineId/unsubscribe
• GET /v1/timeline/:timelineId/subcribers

Posts

• GET /v1/posts/:postId
• DELETE /v1/posts/:postId
• PATCH /v1/posts/:postId
• GET /v1/posts/:postId/comments # not implemented yet
• GET /v1/posts/:postId/likes # not implemented yet
• POST /v1/posts
• POST /v1/posts/:postId/like
• POST /v1/posts/:postId/unlike

Comments

• POST /v1/comments
• DELETE /v1/comments/:commentId
• PATCH /v1/comments/:commentId

Users and groups

• GET /v1/users/:userId
• GET /v1/users/:username/subscriptions
• GET /v1/users/:username/subscribers - returns Posts timeline subscribers
• DELETE /v1/users/:username/subscribers/:userId - unsubscribe :userId from :username
• POST /v1/users/:username/subscribers/:userId/admin - add admin rights for :userId to administrate :username
• POST /v1/users/:username/subscribers/:userId/unadmin - remove admin rights from :userId to administrate :username
• POST /v1/users # it's a dup of sign up
• DELETE /v1/users/:userId
• GET /v1/users/:userId/feedinfo
• not implemented yet
• PATCH /v1/users/:userId

Statistics

• GET /v1/top/:category - returns an array of users with the highest statistics in a category. Category could be one of { "posts", "likes", "discussions", "subscriptions", "subscribers" }

SEARCH API

• GET /v1/search/:searchQuery - returns all posts which equals searchQuery.

Search query is a string of keywords. Keywords:

• intitle:query (search query in post's body)
• incomment:query (search query in comment's body)
• from:username (search by username)
• AND
• OR
• ' ' (whitespace)

If you enter a search phrase that does not match keywords above, search engine will search it in post's and comment's bodies.

Example: this AND intitle:that OR incomment:comment from:user. Search engine will return posts that contain 'that' in post's body and 'this' in post's or comment's body, also it will return posts that contain 'comment' in comment's body and written by user 'user'.