ericwyn/ponza

A comment system for static blog

Ponza

静态博客评论框架，灵感来自 Gitment

Example、示例网址

使用

注意：虽然说Ponza是一个静态博客评论框架，但是还是需要一个服务器后端，只是这样一个后端可以供给诸多不同的网站使用这样

（如果觉得麻烦可以邮箱私戳我，试用我部署的服务～）

后端启用

先从 Release 页面下载 Ponza 的服务器端二进制文件

增加 key

.ponza -k "blog.meetwhy.com"
// 显示如下
key: b9df8d72b06f4f8399c71ab520604320 for host: blog.meetwhy.com

为项目新建一个 key，该 key 只允许使用在来自域名 blog.meetwhy.com 的访问

启动

.ponza

启动项目在 localhost:2334 端口

配置反向代理

将你的 ponza 服务域名反向代理到 localhost:2334，如果你的 caddy 配置示例如下

api.ponza.host.com {
    proxy / localhost:2334 {    
        transparent
    }
}

前端启用

引入 Ponza 的 js 和 css

<link rel="stylesheet" href="https://ericwyn.github.io/Ponza/static/ponza.min.css">
<script src="https://ericwyn.github.io/Ponza/static/ponza.min.js"></script>

配置

Ponza("test",{                                       // 配置评论所在 dom
    page:window.location.pathname,                      // 配置页面标记
    server:"https://wx.meetwhy.com",                    // 配置服务器地址
    key:"b9df8d72b06f4f8399c71ab520604320",             // 配置 key
});

后台数据库

Ponza 将全部数据都存储在本地的 json 文件当中，不需要依赖于数据库 存储的地址是 .ponza 文件夹，每个文件以 host.json 来命名，存储该网站下面所有的评论数据

接口

上传评论接口

• /api/uploadComm

• POST

• 参数

  • key ponza 的 key
  • page 页面的标记
  • comm 评论正文
  • name 评论的昵称
  • site 评论者的网站

• 返回

   "upload message success"
  

获取评论接口

• /api/getComm

• POST

• 参数

  • key ponza 的 key
  • page 页面的标记

• 返回

   {
       "page": "/blog/ubuntu-bash-ch.html",
       "comment": [
           {
               "comm": "评论 : 1544173519984",
               "time": "2018-12-07T17:05:20+08:00",
               "name": "Ericwyn",
               "mail": "[email protected]",
               "agent": "Ubuntu 18.04 上的 Chrome 71.0 浏览器"
           },
           {
               "comm": "评论 : 1544173530023",
               "time": "2018-12-07T17:05:30+08:00",
               "name": "Ericwyn",
               "mail": "[email protected]",
               "agent": "Ubuntu 18.04 上的 Chrome 71.0 浏览器"
           }
       ]
   }
  

评论初始化接口

当评论接口或者上传接口返回 4003 时候代表页面的评论数据未创建，使用该接口创建该页面的数据配置

• api/initComm

• POST

• 参数

  • key ponza 的 key
  • page 页面的标记

• 返回

   "page create success"
  

评论点赞接口 ( 未启用 )

完成评论点赞功能

• api/LikeComm

• POST

• 参数

  • page ponza 的 key
  • comm 评论的标记id

• 返回

错误码

   {"code":"4003"}

• 4000 服务器错误
• 4001 host 错误
• 4002 key 错误
• 4003 page 错误