https://github.com/nodebb/nodebb-plugin-friends
Friendship plugin ala facebook
https://github.com/nodebb/nodebb-plugin-friends
Last synced: 11 months ago
JSON representation
Friendship plugin ala facebook
- Host: GitHub
- URL: https://github.com/nodebb/nodebb-plugin-friends
- Owner: NodeBB
- License: mit
- Created: 2015-03-02T16:18:54.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2022-03-03T17:13:37.000Z (about 4 years ago)
- Last Synced: 2024-04-14T11:52:02.538Z (almost 2 years ago)
- Language: JavaScript
- Size: 53.7 KB
- Stars: 7
- Watchers: 10
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nodebb-plugin-friends
Friendship plugin ala facebook
Replaces the default follow mechanic (ala Twitter) with a moderated friending system which allows users to approve/deny friend requests.
## Optional
If you want a friends button in the /users list, add the following in partials/users_list.tpl
```
[[plugin-friends:action.remove-friend]]
[[plugin-friends:action.add-friend]]
```
## Integration with Write API
If you have the [Write API Plugin](https://github.com/julianlam/nodebb-plugin-write-api) installed, the following routes are exposed for you to use:
* `/friends/:uid`
* `GET /`
* Retrieves all friendship-related data pertaining to the user specified via `uid`, **including pending friendship data**
* Can only be called by an administrative account
* `POST /`
* Requests a friendship from user specified via `userslug`, or accepts a pending friendship, if one is outstanding
* Accepts: Nothing
* `DELETE /`
* Unfriends the user specified via `uid` (relative to the calling user), or rejects a friendship request, if one is outstanding
* Accepts: Nothing