SocialDB is a Redis-backed social graph for Node.js. It uses a friend model similar to Facebook where two users have to follow each other to be friends.
All operations run as asynchronous atomic transactions, so the database is never left in an invalid state. All methods return native Promises. Redis is the ideal storage mechanism for friend relationships, since they can be stored as sets. With sets you can do interesting things with set intersection to find mutual friends, recommended friends, etc. SocialDB stores friend relationships as sorted sets ordered by date.
If you are using yarn:
yarn add socialdb
npm install socialdb --save
Run Redis server if running locally:
Check out Redis quickstart to install.
- follow(fromId, toId)
- unfollow(fromId, toId)
- invite(userId, someId)
- friends(userId) (alias of accepted())
Step 1: Initialize an instance of SocialDB
const SocialDB = ;
Initialize SocialDB, connecting to a Redis client:
const sd = redisClient;
Step 2: Profit
Note: This example uses async/await, only available in Node 7.6+.
// user 2 requests to follow user 3await sdconsole;// ['3']console;// ['2']// user 3 requests to follow user 2 backawait sd;console;// ['3']console;// ['2']// user 2 requests to unfollow user 3await sd;console;// console;// // user 2 invites user with phone number +14153337777await sdconsole;// 
DEBUG=socialdb to your node start script to see debug output. i.e:
DEBUG=socialdb node server.js
yarn install# npm install works toonpm test