A comment system for Ghost platform
A comment system for Ghost platform and other static site generator. Support duoshuo, Disqus and Wordpress dump file. And it's under heavy development now.
tl;dr
Ghost don't have a built in comment support, disqus is hard to access in china, duoshuo frequently crash. The most important thing is that I would like to host my own comment data.
I found a lot of open source comment system on Github, but none of them is easy to use or adapting my needs.
Java
is my favourite programming language. Building a comment system on Java
sounds interesting, and would be quite stable.
Clone the gossip project from github
git clone https://github.com/syhily/gossip.git
Switch to develop
branch
git checkout develop
Make sure maven's bin file mvn
could be executed from your $PATH
mvn clean package -Dmaven.test.skip=true
A distribution package is located in target
directory named in gossip-x.x-SNAPSHOT.tar.gz
form.
Deploy this file to your host server and follow the Basic Configuration part below to run the gossip.
Download the install file from gossip release page or building it from scratch.
Unzip the tar.gz
file, your would find three different directory.
README.md
is the gossip manual for user.LICENSE
is the open source agreement that you should keep in the gossip root path.bin
have two executable file. Run start-gossip-server.sh
to bootstrap your gossip server.config
is the configuration directory for gossip.lib
is main gossip server library and other third part library.Modify the file gossip.properties
located in config
directory to adapt your needs.
TODO frontend and proxy server configuration
TODO, would be finished before the initial release of gossip.
RESTEASY018525: Unexpected org.jboss.resteasy.spi.UnhandledException: org.jboss.resteasy.core.NoMessageBodyWriterFoundFailure: Could not find MessageBodyWriter for response object of type: me.yufan.gossip.rest.response.BaseApiResponse of media type: application/octet-stream
This is a known issue on resteasy & netty integration, don't worry. It doesn't affect the SLA of gossip.
This log would be shown in gossip.log
if you set the gossip to debug mode. But this is a helper log for developer, ignore it if you are a gossip user.
The gossip backend part is build upon three famous framework on Java:
You should be familiar with them before devoting yourself into the gossip development. IntelliJ IDEA is the recommend IDE for backend server development.
lombok plugin need to be installed on your favourite IDE.
Our frontend library gossip.min.js
required jQuery
for development convenience, your should place jQuery before gossip's js
on your page.
The frontend library using Gulp to package and other decoration flow like eslint
, its development
requires the Node.js
runtime environment.
You should know the basic usage of Node.js
and Gulp
before the modification of gossip library.
Gossip backend server is built upon java, but it does't sound like a good choice to use Java to serve the page. Because
java's template library like freemarker
or velocity
is really hard to use.
Our gossip admin panel is built on facebook's famous framework react.js and Alibaba's antd design.
You should be good at react development.
I hate angular.js, it's too ugly in its design memo.
If you have any problems with or questions about this program, please contact us through a GitHub issue.
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.