nodeSolidServer / nodeSolidServer/node-solid-server

solid-notifications

Open
#1,780 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.8k
Forks
308
PR merge metrics
No merged PRs in 30d

Description

Objectives : apply solid-notifications protocol https://solid.github.io/notifications/protocol
and compatibility with CSS implementation https://github.com/CommunitySolidServer/CommunitySolidServer/documentation/markdown/usage/notifications.md

  • discovery subscription service : link header (relative URL ?)
    link: <.well-known/solid-notifications>; rel="http://www.w3.org/ns/solid/terms#storageDescription"
  • turtle subscription service document (if turtle relative ?)
    - [ ] WebSocketChannel2023 : podRoot/.notifications/WebSocketChannel2023/
    - [ ] WebHookChannel2023 : podRoot/.notifications/WebHookChannel2023/
  • subscription
    - [ ] authenticated json-ld POST
    - [ ] read followed item
    - [ ] json-ld response (contains subscription URL)
  • default duration of the subscription URL) : 2 weeks (?)
  • unsubscribe : DELETE the subscription url received in the subscription response (no need to be authenticated)
  • notifications messages json-ld
    - [ ] notification types
    - [ ] extra features

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the Solid Notifications protocol with the linked CommunitySolidServer compatibility documentation, then map each checklist item to the existing notification-related code in node-solid-server. Done means implementing and testing discovery, subscription, channel documents, unsubscribe behavior, duration, and JSON-LD notification messages, including the listed notification types and features.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.