Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dyu/comments
A real-time, markdown-enabled comment engine powered by leveldb with oauth support
https://github.com/dyu/comments
commenting comments discussion markdown oauth2 real-time self-hosted static-blog static-site sveltejs
Last synced: 24 days ago
JSON representation
A real-time, markdown-enabled comment engine powered by leveldb with oauth support
- Host: GitHub
- URL: https://github.com/dyu/comments
- Owner: dyu
- License: apache-2.0
- Created: 2017-05-05T04:18:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-28T09:06:04.000Z (over 1 year ago)
- Last Synced: 2024-09-30T09:40:50.484Z (about 1 month ago)
- Topics: commenting, comments, discussion, markdown, oauth2, real-time, self-hosted, static-blog, static-site, sveltejs
- Language: HTML
- Homepage: https://dyu.github.io/comments/
- Size: 811 KB
- Stars: 63
- Watchers: 6
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# comments app
A real-time comment engine with support for anonymous or authenticated posts
### Quickstart
```sh
mkdir -p target/standalone && cd target/standalone
wget https://cdn.jsdelivr.net/npm/[email protected]/bin/comments-linux-standalone-x64.tar.gz
tar -xzf comments-linux-standalone-x64.tar.gz
./start.sh
```
The [demo](https://netlify-comments.dyuproject.com) is running on a $2.5 vultr plan located in SG, with the app [configured](ARGS.txt) to use a max memory of 128mb (to leave most of the available memory to the filesystem cache).
## Instant comments on your site/blog
Put this anywhere in the html body (although it is advisable to put it last)
```html
window.comments_config = {
collapse_depth: 7, // the depth where comments get collapsed by default
limit_depth: 10, // max: 127
//auth_host: 'https://api.dyuproject.com', // if you prefer authenticated comments
ws_enabled: true, // real-time updates
ws_host: 'wss://rpc.dyuproject.com/sub',
rpc_host: 'https://rpc.dyuproject.com'
}
```
> Note: Uses the same instance powering the demo. No tracking whatsoever.
1. The [css](https://dyu.github.io/comments/dist/build.css) is 7.1kb minified, built with [pavilion](https://github.com/getpavilion/pavilion) core.
2. The [js](https://dyu.github.io/comments/dist/build.js) is 91.8kb minified, built with:
- [sveltjs](https://github.com/sveltejs/svelte)
- [showdown](https://github.com/showdownjs/showdown)
- [dompurify](https://github.com/cure53/DOMPurify)
- [string-hash](https://github.com/darkskyapp/string-hash)
- [color-hash](https://github.com/zenozeng/color-hash)
## Server runtime dependencies
- jdk7
## Dev requirements
- [node](https://nodejs.org/en/download/) 6.9.0 or higher
- yarn (npm install -g yarn)
- jdk7 (at /usr/lib/jvm/java-7-oracle)
- [maven](https://maven.apache.org/download.cgi)
- [protostuffdb](https://gitlab.com/dyu/protostuffdb) (downloaded below)
## Setup
```sh
mkdir -p target/data/main
echo "Your data lives in user/ dir. Feel free to back it up." > target/data/main/README.txt
# download protostuffdb
yarn add [email protected] && mv node_modules/protostuffdb/dist/* target/ && rm -f package.json yarn.lock && rm -r node_modules
wget -O target/fbsgen-ds.jar https://repo1.maven.org/maven2/com/dyuproject/fbsgen/ds/fbsgen-ds-fatjar/1.0.10/fbsgen-ds-fatjar-1.0.10.jar
./modules/codegen.sh
mvn install
npm install -g http-server clean-css-cli
cd comments-ts
yarn install
```
## Dev mode
```sh
# produces a single jar the first time (comments-all/target/comments-all-jarjar.jar)
./run.sh
# on another terminal
cd comments-ts
# serves the ui via http://localhost:8080/
yarn run dev
```
If your dev machine is a MacOS, **protostuffdb** currently does not have binary distributions for it (no MacOS machine to test/build against).
On the other hand, you can still do development on the client-side part with this temporary workaround:
1. Edit ```comments-ts/index.html```
2. Replace ```window.rpc_host = 'http://127.0.0.1:5020'``` with ```window.rpc_host = 'https://rpc.dyuproject.com'```
## Production mode
```sh
cd comments-ts
# produces a single js and other assets in comments-ts/dist/
yarn run build
```