me/ucs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
universal comment system
36 Commits 1 Branch 0 Tags 299 KiB
JavaScript 87.3%
CSS 7.4%
Shell 2.9%
HTML 2.4%
trunk
Go to file
me dede3a16c5 license
2025-03-15 19:30:03 +02:00
backend frontend fixes: reload comments after submitting instead of refresh, 2025-03-15 18:50:10 +02:00
frontend readme 2025-03-15 19:18:57 +02:00
.gitignore add prod settings for backend and a bundle script 2025-03-14 09:21:59 +02:00
bundle.sh sites moved to configuration instead of db 2025-03-15 11:47:10 +02:00
clean.sh -f 2025-03-14 10:14:10 +02:00
license.txt license 2025-03-15 19:30:03 +02:00
readme.md fixing typos 2025-03-15 19:22:40 +02:00
screenshot.png readme 2025-03-15 19:18:57 +02:00

readme.md

Universal Comment System

A web service adding comments to websites.

The backend service serves as a simple read/write database for comments per website page, and the frontend is an embeddable component you can place in your page that will interact with the backend service.

Screenshot

screnshot

Build

Requires Node.js.

Use ./bundle.sh to generate a .tar.gz containing the service.

Run

Extract the archive file produced by bundle.sh into a directory. For example:

mkdir ucs/ && tar xzvf ucs-*.tar.gz -C ucs/

Create a configuration file for your website in ./ucs/config/production.json. See backend/config/default.json for an example configuration.

Then add the following HTML to your website page, changing the parameters marked in []:

<div id="ucs-comments"
     data-element="ucs-comments"
     data-ucs_url="[SERVICE_URL]"
     data-site="[WEBSITE]"
     data-path="[PAGE_PATH]"
></div>
<script type="module" src="[SERVICE_URL]/ucs.js"></script>
<link rel="stylesheet" type="text/css" href="[SERVICE_URL]/ucs.css">