Skip to content
Jamments is a self hosted commenting API that puts you in control
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
article
controllers
docs
infos
libs
models
.editorconfig
.eslintrc
.gitignore
README.md
apidoc.json
config.dist.js
createTables.js
migrateWordpress.js
package-lock.json
package.json
sendTestEmail.js
server.js
tables.sql

README.md

Jamments

Jamments, which stands for JAMstack comments, is a self hosted commenting API that just works with your site.

There's no script to include, no automatic DOM injection, no default CSS to customize, you're in full control. It's a dead simple REST API that seamlessly integrates with your already existing JAMstack.

You're free to choose the database you want to work with:

  • SQLite
  • MySQL
  • MariaDB
  • PostgreSQL
  • MSSQL

It's written in Node.js and is automatically cached, so no worries, it's fast!

Caching strategy

Everything is cached by default. This means that when data is fetched, it is served straight from your webserver, without even hitting Jamments' API.

Cached files are updated only when data changes. No change, no update, no work.

Spam control

The API is meant to be autonomous and doesn't relly on external APIs. The rationale for spam filtering is that spammers will basically enter fake emails.

Hence, for a comment to be validated, commenter will be sent an email with a validation link. The link contains information that must be sent back to the API in order to validate the comment.

On top of that, administrator can delete inapropriate comments.

Documentation

Head to the docs to get started. And don't forget to star this repo 😇

Contributing

There's sure room for improvement, so feel free to hack around and submit PRs!

That would be cool for instance if we could have proper HTML emails. So if you have the skills to code HTML emails, don't hesitate to give me a helping hand!

Please just follow the style of the existing code, which is Airbnb's style with minor modifications.

To maintain things clear and visual, please follow the git commit template.

You can’t perform that action at this time.