comments - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #android #rust #macos #awesome #kubernetes #pytorch #security #ios #openai #open-source

comments

(★ 63)

A real-time, markdown-enabled comment engine powered by leveldb with oauth support

파일 탐색기

최종 버전 다운로드 (.zip)

- - comments.service
- ansible.cfg
- deploy.sh
- deploy.yml
- README.md
- pom.xml
- d.sh
- dlip.sh
- dstool
- lip.sh
- pom.xml
- - LICENSE.txt
- - Comment.html
  - Comments.html
  - escape.js
  - main.js
  - rpc.js
  - util.js
- favicon.ico
- icon.png
- index.html
- package.json
- rollup.config.js
- sub.html
- yarn.lock
- - build.css
  - build.js
  - build.js.map
  - gh.png
- - index.html
- - index.html
- favicon.ico
- index.html
- - _.properties
  - pom.xml
- base-codegen.properties
- codegen.sh
- - upstream.conf
  - www
- files.txt
- s-archive.sh
- s-start.sh
- tag.sh
.gitignore
ARGS.txt
CHANGELOG.md
LICENSE.txt
pom.xml
PORT.txt
README.md
run.properties
run.sh
screenshot.png

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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/dyu-comments@0.6.0/bin/comments-linux-standalone-x64.tar.gz
tar -xzf comments-linux-standalone-x64.tar.gz
./start.sh
```

![screenshot](https://github.com/dyu/comments/raw/master/screenshot.png)

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
<div id="comments"></div>
<script>
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'
}
</script>
<script src="https://netlify-comments.dyuproject.com/dist/build.js"></script>
<link rel="stylesheet" href="https://netlify-comments.dyuproject.com/dist/build.css" />
```
> 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 protostuffdb@0.14.0 && 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
```