Skip to content

Commit

Permalink
docs(guide): add features
Browse files Browse the repository at this point in the history
  • Loading branch information
@g-div
g-div committed Feb 7, 2018
1 parent 23be578 commit 775b8b5
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 54 deletions.
35 changes: 18 additions & 17 deletions docs/docs.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# What the schnack?

Schnack is an open source commenting system written in JavaScript.
- 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](https://tools.ietf.org/html/draft-ietf-webpush-protocol-12) 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*.
Expand All @@ -9,7 +19,7 @@ This is the fastest way to setup *schnack*.
Clone or download schnack:

```bash
git clone https://github.com/gka/schnack
git clone https://github.com/schn4ck/schnack
```

Go to the schnack directory:
Expand Down Expand Up @@ -76,8 +86,8 @@ The fields *schnack_host* and *page_url* should be hosted on the **same domain**
|     app_token | the Pushover app token |
|     user_key | the Pushover user key |
|   webpush | |
|     vapid_public_key | the [webpush](https://github.com/gka/schnack#push-notifications-for-new-comments) public key |
|     vapid_private_key | the [webpush](https://github.com/gka/schnack#push-notifications-for-new-comments) private key |
|     vapid_public_key | the [webpush](https://github.com/schn4ck/schnack#push-notifications-for-new-comments) public key |
|     vapid_private_key | the [webpush](https://github.com/schn4ck/schnack#push-notifications-for-new-comments) private key |
|   slack | |
|     webhook_url | the Slack webhook URL |
| date_format | how to display dates (e.g. *MMMM DD, YYYY - h:mm a*) |
Expand Down Expand Up @@ -130,7 +140,7 @@ node_modules/.bin/web-push generate-vapid-keys

- Copy the VAPID keys in `config.json`
- Add your user ID to the *admin* array in `config.json`
- Copy the [sw.js](https://github.com/gka/schnack/blob/master/sw.js) into your website's root path, so that this will be accessible at https://comments.mysite.com/sw.js
- Copy the [sw.js](https://github.com/schn4ck/schnack/blob/master/sw.js) into your website's root path, so that this will be accessible at https://comments.mysite.com/sw.js
- Login to your *schnack* instance and you will be asked to grant the permission for push notifications.

When a new comment is posted, you will be notified with a notification. In order to avoid flooding, *schnack* will send only a notification every 5 minutes, highlighting the number of comments awaiting for approval.
Expand Down Expand Up @@ -207,29 +217,20 @@ npm run import -- disqus.xml
You can build a Docker image for the schnack server running:

```bash
docker build -t gka/schnack .
docker build -t schn4ck/schnack .
```

The image will contain everything in the project folder and can be started with:

```bash
docker run -p 3000:3000 -d gka/schnack
docker run -p 3000:3000 -d schn4ck/schnack
```

In order to be able to edit your config file and your SQL database files, you may want to share the project folder with the docker container:

```bash
docker run -p 3000:3000 -v $(pwd):/usr/src/app -d gka/schnack
docker run -p 3000:3000 -v $(pwd):/usr/src/app -d schn4ck/schnack
```

# How it works ?

*schnack* is based on Node.JS and uses SQLite as a database.

# Development

If you want to help us to improve schnack we are happy about contributions on [GitHub](https://github.com/schn4ck/schnack).

# Try schnack

Here you can leave us some comments. Let us know what you think about schnack!
Here you can leave us some comments. Let us know what you think about schnack!
67 changes: 30 additions & 37 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@
<aside>
<img src="schnack-logo_small.jpg" alt="Schnack logo - SCHNACK!"/>
<nav>
<a
class="nav__item nav__item-1"
href="#what-the-schnack-"
>
What the schnack?
</a>


<a
class="nav__item nav__item-1"
href="#quickstart"
Expand Down Expand Up @@ -118,22 +126,6 @@
</a>


<a
class="nav__item nav__item-1"
href="#how-it-works-"
>
How it works ?
</a>


<a
class="nav__item nav__item-1"
href="#development"
>
Development
</a>


<a
class="nav__item nav__item-1"
href="#try-schnack"
Expand All @@ -149,6 +141,21 @@ <h1>schnack<span>!</span></h1>
</header>
<div class="content">

<h1 id="what-the-schnack-">
<a class="anchor" href="#what-the-schnack-">
What the schnack?
</a>
</h1>
<p>Schnack is an open source commenting system written in JavaScript. </p>
<ul>
<li>Tiny! It takes only ~<strong>8 KB!!!</strong> to embed Schnack.</li>
<li><strong>Open source</strong> and <strong>self-hosted</strong>.</li>
<li>Ad-free and Tracking-free. Schnack will <strong>not disturb your users</strong>.</li>
<li>It&#39;s simpy to moderate, with a <strong>minimal</strong> and <strong>slick UI</strong> to allow/reject comments or trust/block users.</li>
<li><strong><a href="https://tools.ietf.org/html/draft-ietf-webpush-protocol-12">webpush protocol</a> to notify the site owner</strong> about new comments awaiting for moderation.</li>
<li><strong>Third party providers for authentication</strong> like Github, Twitter, Google and Facebook. Users are not required to register a new account on your system and you don&#39;t need to manage a user management system.</li>
</ul>

<h1 id="quickstart">
<a class="anchor" href="#quickstart">
Quickstart
Expand All @@ -161,7 +168,7 @@ <h1 id="quickstart">
<li>npm (&gt;= v5)</li>
</ul>
<p>Clone or download schnack:</p>
<pre><code class="lang-bash">git clone https://github.com/gka/schnack
<pre><code class="lang-bash">git clone https://github.com/schn4ck/schnack
</code></pre>
<p>Go to the schnack directory:</p>
<pre><code class="lang-bash">cd schnack
Expand Down Expand Up @@ -297,11 +304,11 @@ <h1 id="configuration">
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;&nbsp;vapid_public_key</td>
<td>the <a href="https://github.com/gka/schnack#push-notifications-for-new-comments">webpush</a> public key</td>
<td>the <a href="https://github.com/schn4ck/schnack#push-notifications-for-new-comments">webpush</a> public key</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;&nbsp;vapid_private_key</td>
<td>the <a href="https://github.com/gka/schnack#push-notifications-for-new-comments">webpush</a> private key</td>
<td>the <a href="https://github.com/schn4ck/schnack#push-notifications-for-new-comments">webpush</a> private key</td>
</tr>
<tr>
<td>&nbsp;&nbsp;slack</td>
Expand Down Expand Up @@ -397,7 +404,7 @@ <h3 id="web-push">
<ul>
<li>Copy the VAPID keys in <code>config.json</code></li>
<li>Add your user ID to the <em>admin</em> array in <code>config.json</code></li>
<li>Copy the <a href="https://github.com/gka/schnack/blob/master/sw.js">sw.js</a> into your website&#39;s root path, so that this will be accessible at <a href="https://comments.mysite.com/sw.js">https://comments.mysite.com/sw.js</a></li>
<li>Copy the <a href="https://github.com/schn4ck/schnack/blob/master/sw.js">sw.js</a> into your website&#39;s root path, so that this will be accessible at <a href="https://comments.mysite.com/sw.js">https://comments.mysite.com/sw.js</a></li>
<li>Login to your <em>schnack</em> instance and you will be asked to grant the permission for push notifications.</li>
</ul>
<p>When a new comment is posted, you will be notified with a notification. In order to avoid flooding, <em>schnack</em> will send only a notification every 5 minutes, highlighting the number of comments awaiting for approval.</p>
Expand Down Expand Up @@ -497,29 +504,15 @@ <h1 id="docker">
</a>
</h1>
<p>You can build a Docker image for the schnack server running:</p>
<pre><code class="lang-bash">docker build -t gka/schnack .
<pre><code class="lang-bash">docker build -t schn4ck/schnack .
</code></pre>
<p>The image will contain everything in the project folder and can be started with:</p>
<pre><code class="lang-bash">docker run -p 3000:3000 -d gka/schnack
<pre><code class="lang-bash">docker run -p 3000:3000 -d schn4ck/schnack
</code></pre>
<p>In order to be able to edit your config file and your SQL database files, you may want to share the project folder with the docker container:</p>
<pre><code class="lang-bash">docker run -p 3000:3000 -v $(pwd):/usr/src/app -d gka/schnack
<pre><code class="lang-bash">docker run -p 3000:3000 -v $(pwd):/usr/src/app -d schn4ck/schnack
</code></pre>

<h1 id="how-it-works-">
<a class="anchor" href="#how-it-works-">
How it works ?
</a>
</h1>
<p><em>schnack</em> is based on Node.JS and uses SQLite as a database.</p>

<h1 id="development">
<a class="anchor" href="#development">
Development
</a>
</h1>
<p>If you want to help us to improve schnack we are happy about contributions on <a href="https://github.com/schn4ck/schnack">GitHub</a>.</p>

<h1 id="try-schnack">
<a class="anchor" href="#try-schnack">
Try schnack
Expand Down

0 comments on commit 775b8b5

Please sign in to comment.