https://github.com/buzut/jamments

Jamments is a self hosted commenting API that puts you in control
https://github.com/buzut/jamments

comment-api comment-system commenting comments jamstack

Last synced: 19 days ago
JSON representation

Jamments is a self hosted commenting API that puts you in control

• Host: GitHub
• URL: https://github.com/buzut/jamments
• Owner: Buzut
• Created: 2019-03-09T18:01:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T01:47:50.000Z (almost 2 years ago)
• Last Synced: 2024-12-06T17:15:24.704Z (about 1 month ago)
• Topics: comment-api, comment-system, commenting, comments, jamstack
• Language: JavaScript
• Homepage: https://buzut.github.io/jamments/
• Size: 1.95 MB
• Stars: 17
• Watchers: 2
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://jamstack.org/).

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](https://buzut.github.io/jamments/) 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](http://airbnb.io/javascript/) with [minor modifications](.eslintrc).

To maintain things clear and visual, please follow the [git commit template](https://github.com/Buzut/git-emojis-hook).