Skip to content
forked from schn4ck/schnack

🗣️ Simple node app for Disqus-like drop-in commenting on static websites

License

Notifications You must be signed in to change notification settings

niradler/schnack

 
 

Repository files navigation

schnack.js

Schnack is a simple Disqus-like drop-in commenting system written in JavaScript.

What the schnack?

Features:

  • Tiny! It takes only ~8 KB!!! to embed Schnack.
  • Open source and self-hosted.
  • Ad-free and Tracking-free. Schnack will not disturb your users.
  • It's simpy to moderate, with a minimal and slick UI to allow/reject comments or trust/block users.
  • webpush protocol to notify the site owner about new comments awaiting for moderation.
  • Third party providers for authentication like Github, Twitter, Google and Facebook. Users are not required to register a new account on your system and you don't need to manage a user management system.

Quickstart

This is the fastest way to setup schnack.

Requirements:

  • Node.js (>= v6)
  • npm (>= v5)

Clone or download schnack:

git clone https://github.com/schn4ck/schnack

Go to the schnack directory:

cd schnack

Install dependencies:

npm install

Copy and edit the config file according to configuration section:

cp config.tpl.json config.json
vim config.json                 # or open with any editor of your choice

Run the server:

npm start

Embed in your HTML page:

<div class="comments-go-here"></div>
<script src="https://comments.example.com/embed.js"
    data-schnack-slug="post-slug"
    data-schnack-target=".comments-go-here">
</script>

or initialize schnack programmatically:

<div class="comments-go-here"></div>

<script src="http://comments.example.com/client.js"></script>
<script>
    new Schnack({
        target: '.comments-go-here',
        slug: 'post-slug',
        host: 'http://comments.example.com'
    });
</script>

You will find further information on the schnack page.

Configuration

Notify Providers:

  • pushover
  • webpush
  • slack
  • rss
  • sendmail

Who is behind Schnack?

Schnack is yet another happy collaboration between Webkid and Gregor Aisch.

Who is using Schnack?

Schnack will never track who is using it, so we don't know! If you are a Schnack user, let us know and we'll add your website here. So far Schnack is being used on:

Related projects

This is not a new idea, so there are a few projects that are doing almost the same thing:

About

🗣️ Simple node app for Disqus-like drop-in commenting on static websites

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.3%
  • HTML 8.3%
  • CSS 1.5%
  • Other 0.9%