🕸 small commenting engine for static blogs

Marcus Rohrmoser ea6805d5ce add a doap 5 months ago
LICENSE 6615dc7603 Initial commit 5 years ago
README.md 1eba9f2fe3 Update README.md 8 months ago
doap.rdf ea6805d5ce add a doap 5 months ago

README.md

static-comments

Maybe

is what I'm looking for and am describing below. Have to check.

Goal

tiny, self-hosted commenting engine for static websites and blogs as created with e.g. hugo, octopress, nanoc or just handcrafted.

Usage

  1. drop the project on your webserver,
  2. embed a script and div tag into your webpages.

Actors

  • Moderator
  • Commenter
  • Reader
  • Spammer

Usecases

/UC10/ Leave a comment (first)

Actor: Commenter

  • enter a nick and your email
  • enter comment
  • solve reCAPTCHA
  • see your comment waiting for moderation
  • eventually receive an email and see your comment published

/UC20/ Leave a comment (returning)

Actor: Commenter

  • enter comment
  • see your comment published

/UC30/ Moderate 'first' comment

Actor: Moderator

  • login
  • subscribe the comments-unmoderated rss feed or
  • check the comments-unmoderated url
  • mark comments as spam/ham

/UC40/ Mark 'returning' comment as spam

Actor: Moderator

  • subscribe the comments rss feed or
  • check the comments url
  • login
  • mark comments as spam/ham

/UC50/ Mark 'first' spam as ham

If using spam-detection (e.g. Akismet) comments may be false positive spam.

Actor: Moderator

  • login
  • subscribe the comments-spam rss feed or
  • check the comments-spam url
  • mark comments as spam/ham

/UC60/ Read comments

Actor: Reader

  • see x most recent comments
  • see all comments for an article

/UC70/ Leave spam comment

Actor: Spammer

  • enter a nick and your email
  • enter comment
  • solve reCAPTCHA
  • see your comment waiting for moderation

Data / API

Run without any DB, just JSON or RDF files.

/D10/ Lorem Ipsum

Performance

  • 1000 comments per article
  • 10000 comments per commenter
  • 100000 comments

Quality

Quality very good good normal  irrelevant
Functionality ×
Reliability ×
Usability ×
Efficiency ×
Changeability ×
Portability ×

Appendix