Example Proposal: Comments

I have an idea for a new example for ShareDB: Comments. This would be a simple interface that lets users add comments to a thread, similar to GitHub Issues.

The goal is to demonstrate how to do the following combination of things with ShareDB, which I have been struggling to do for some time now:

• Securely allow only certain queries, and deny all others (do not allow the client to execute arbitrary queries)
• Server-render the first query results
• Hydrate a Query client-side
• Ensure the query result set updates when a new comment is added or an existing comment is deleted
• Ensure each document in the query result set updates (e.g. when a comment is edited)

Would there be interest in adding such an example?

Related:

• https://github.com/share/sharedb/blob/master/examples/leaderboard/client/Leaderboard.jsx#L20
• https://github.com/share/sharedb/issues/189
• https://github.com/balek/sharedb-server-query
• https://github.com/share/sharedb/issues/501

Start by reviewing examples/leaderboard/client/Leaderboard.jsx and the related issues #189 and #501, then compare the sharedb-server-query project. Define the example's server and client entry points from the requested behaviors. Done means a Comments example demonstrates restricted queries, server rendering, client hydration, and updates for added, deleted, and edited comments.