# vue-bbs

> Serverless comment system in Vue

Latest version **0.1.4** (published 2022-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-bbs
pnpm add vue-bbs
yarn add vue-bbs
bun add vue-bbs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2022-11-06 |
| First published | 2021-09-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 (+8 in 7 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | stonehank |
| Maintainers | stonehank |
| Keywords | vue, comments, simple, easy-to-use, fast-and-safe, comment-system |

## Links

- npm: https://www.npmjs.com/package/vue-bbs
- Repository: https://github.com/stonehank/vue-bbs
- Homepage: https://github.com/stonehank/vue-bbs#README
- Issues: https://github.com/stonehank/vue-bbs/issues
- npm.io page: https://npm.io/package/vue-bbs

## Dependencies (13)

- [vue](https://npm.io/package/vue.md) ^2.6.11
- [xss](https://npm.io/package/xss.md) ^1.0.9
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [marked](https://npm.io/package/marked.md) ^0.8.1
- [mockjs](https://npm.io/package/mockjs.md) ^1.1.0
- [firebase](https://npm.io/package/firebase.md) ^9.1.1
- [js-cookie](https://npm.io/package/js-cookie.md) ^2.2.1
- [clone-deep](https://npm.io/package/clone-deep.md) ^4.0.1
- [html-to-md](https://npm.io/package/html-to-md.md) ^0.5.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0
- [blueimp-md5](https://npm.io/package/blueimp-md5.md) ^2.12.0
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.18.1
- [vue2-transitions](https://npm.io/package/vue2-transitions.md) ^0.3.0

## Recent versions

- 0.1.4 (latest) — 2022-11-06
- 0.1.3 — 2021-10-22
- 0.1.2 — 2021-10-08
- 0.1.1 — 2021-10-08
- 0.1.0 — 2021-10-08
- 0.0.4 — 2021-09-25
- 0.0.3 — 2021-09-25
- 0.0.2 — 2021-09-25
- 0.0.1 — 2021-09-24

## README

> Serverless BBS(comment system) in Vue

[English](https://github.com/stonehank/vue-bbs/blob/main/README-EN.md) / 中文

## 目前支持的服务器

* [Leancloud](#Leancloud客户端设置)
* [Firebase](#Firebase客户端设置)

## DEMO

[项目实例(深/浅主题)](https://stonehank.github.io/projects#project-comments)

[测试](https://stonehank.github.io/vue-bbs)


## 安装

`npm install vue-bbs`


## 使用

`<vue-bbs />` 评论系统最主要部分，包括评论，回复查看等

`<vue-bbs-counter />` 当前页面的评论总数

`<vue-bbs-pageview />` 当前页面的页面浏览量


### 全局引入

##### Leancloud

```js
// index.js
import Vue from 'vue'
import bbs from 'vue-bbs'

Vue.use(bbs,{
    appId:"#########-####",
    appKey:"#######",
    serverURLs:"#####.##.##.com",
    editMode:false,
    CommentClass:"Comments",
    CounterClass:"Counters",
})
```

##### Firebase

```js
// index.js
import Vue from 'vue'
import bbs from 'vue-bbs'
import FirebaseLayer from 'vue-bbs/backend/firebase'

Vue.use(bbs,{
    apiKey: '############',
    projectId: '########',
    editMode:false,
    CommentClass:"Comments",
    CounterClass:"Counters",
    server:FirebaseLayer,
})
```

接着，便可以在任意处使用 `<vue-bbs>`,`<vue-bbs-counter>`,`<vue-bbs-pageview>`

### 局部引入

##### Leancloud

```js
// index.js
import register from "vue-bbs/register";
register(Vue,{
    appId:"#########-####",
    appKey:"#######",
    serverURLs:"#####.##.##.com",
    editMode:false,
    CommentClass:"Comments",
    CounterClass:"Counters",
})
```

```vue
// 需要引入的文件.vue
<template>
    <vue-bbs-counter uniqStr="contact-page" />
    <vue-bbs :nest="2" :pageSize="10" uniqStr="contact-page" />
</template>

<script>
    import VueBbs from "vue-bbs/lib/vue-bbs";
    import VueBbsCounter from "vue-bbs/lib/vue-bbs-counter";
    import ServerLayer from 'vue-bbs/backend/leancloud'
    import registerServer from "vue-bbs/registerServer";
    registerServer(VueBbs,ServerLayer)
    registerServer(VueBbsCounter,ServerLayer)
    export default {
        name: "VueBBSPanel",
        components:{
            VueBbs,
            VueBbsCounter
        }
    }
</script>
```

##### Firebase

```js
// index.js
import register from "vue-bbs/register";
register(Vue,{
    editMode:false,
    CommentClass:"Comments_demo",
    CounterClass:"Counters_demo",
    apiKey: 'AIzaSyAQTct1trRnIB7QLE9RZ6qZgHGahVNrvco',
    projectId: 'servelessbbs',
})
```

```vue
// 需要引入的文件.vue
<template>
    <vue-bbs-counter uniqStr="contact-page" />
    <vue-bbs :nest="2" :pageSize="10" uniqStr="contact-page" />
</template>

<script>
    import VueBbs from "vue-bbs/lib/vue-bbs";
    import VueBbsCounter from "vue-bbs/lib/vue-bbs-counter";
    import ServerLayer from 'vue-bbs/backend/firebase'
    import registerServer from "vue-bbs/registerServer";
    registerServer(VueBbs,ServerLayer)
    registerServer(VueBbsCounter,ServerLayer)
    export default {
        name: "VueBBSPanel",
        components:{
            VueBbs,
            VueBbsCounter
        }
    }
</script>
```

---

如果你的应用需要多处使用，那么多次调用必然繁琐，可以将三个组件分别封装，就不需要重复的调用`registerServer`，
例如创建一个自定义组件：`CustomVueBbs`，封装如下，之后便可以直接调用`CustomVueBbs`

```vue
// CustomVueBbs.vue
<template>
    <vue-bbs v-bind="$attrs" />
</template>

<script>
    import VueBbs from "vue-bbs/lib/vue-bbs";
    import ServerLayer from 'vue-bbs/backend/firebase'
    import registerServer from "vue-bbs/registerServer";
    registerServer(VueBbs,ServerLayer)
    export default {
        name: "VueBBSPanel",
        inheritAttrs:false,
        components:{
            VueBbs,
        }
    }
</script>
```


## Leancloud客户端设置

#### APP ID/Key

[登录](https://console.leancloud.app/login) `LeanCloud`, 
进入 [控制台](https://console.leancloud.app/apps/) 
后点击创建应用

![](https://i.loli.net/2019/06/21/5d0c995c86fac81746.jpg)

应用创建好以后，进入刚刚创建的应用，选择左下角的`设置`>`应用凭证`，然后就能看到你的`APP ID`和`APP Key`了：

![](https://i.loli.net/2019/06/21/5d0c997a60baa24436.jpg)

#### serverURLs

`serverURLs`在应用内部会尝试自动获取，如果发现获取失败，请手动提供
刚刚创建的应用，选择左下角的`设置`>`应用Key`，找到`Request 域名` 第一行
![](./doc/images/setting3.png)

#### 初始化

应用内部调用

`<vue-bbs><vue-bbs/>`和

`<vue-bbs-pageview></vue-bbs-pageview>`，

发送一条测试消息，系统会自动创建对应的`Comment`表和`Counter`表；当创建完所需表后，在服务设置里面勾选`禁止客户端创建Class`

![leancloud-forbid-class](./doc/images/leancloud-forbid-class.png)

#### 配置 Comment 表

在客户端 `Comment` 表中(也可能是你的自定义名称`CommentClass`)

1. 勾选 `mail`列的`客户端不可见`
    
    ![setting1](./doc/images/setting2.png)

2. 关闭`add_fields`权限

    ![setting5](./doc/images/setting5.png)
    
#### 配置 _User 表

当你在`LeanCloud`客户端开启一个新的应用后，新创建的应用的 _User 表除了`create`和`find`，其他全部权限关闭

![setting1](./doc/images/setting1.png)



至此， Leancloud 构建完毕！


## Firebase客户端设置

[登录](https://console.firebase.google.com/) `Google`账号并且进入`Firebase`控制台，创建项目

#### apiKey和projectId

点击左上方小齿轮，进入`项目设置`

![firebase-2](./doc/images/firebase-2.png)

找到你的`项目id`和`api密钥`

![firebase-3](./doc/images/firebase-3.png)

要使用`Firebase`，`vue-bbs`需要接收

```
apiKey: [Your API Key]
projectId: [Your Project ID]
```
#### Authentication配置

点击左侧栏`Authentication`，点击`启用`->`设置登录方法`，选择`电子邮件`，点击`启用`，`保存`


#### Firebase配置


* 启用Database

    左侧栏选择`Firestore Database`，选择创建数据库
    
    ![firebase-1](./doc/images/firebase-1.png)
    
    选择生产模式或者测试模式都可以，后面会覆盖掉规则配置;
    
    选择地区位置后，创建成功

* 重写规则

    复制以下规则，注意其中方括号内`[YourComments]`和`[YourCountres]`需要替换成你自定义的存放评论表格名称和存放页面浏览量的表名称
    
    点击发布
    ```
    service cloud.firestore {
      match /databases/{database}/documents {
        match /[YourComments]/{id} {
          allow read: if true;
          allow create: if true;
          allow update: if  request.auth != null 
          &&  request.auth.uid == resource.data.user_id 
          allow delete: if false;
        }
         match /[YourComments]_private/{id} {
          allow read: if false;
          allow create: if true;
          allow update: if  request.auth != null 
          &&  request.auth.uid == id;
          allow delete: if false;
        }
         match /[YourCounter]/{id} {
          allow read: if true;
          allow create: if true;
          allow update: if true;
          allow delete: if false;
        }
      }
    }
    ```

* 建立索引

    点击`索引` -> `复合索引` ->创建
    
    ![firebase-index-0](./doc/images/firebase-index-0.png)
    
    填写你的`Comment`表格名称
    
    ![firebase-index-1](./doc/images/firebase-index-1.png)
    
    添加字段`uniqStr`和`createdAt`，分别为`Ascending`和`Descending`, 选择查询范围`集合`
    
    ![firebase-index-2](./doc/images/firebase-index-2.png)
    
    点击创建索引，索引构建大概会消耗几分钟时间


至此， Firebase 构建完毕！

## 选项

#### 注册Leancloud

|参数|是否必须|说明|默认值|
|:---:|:---:|:---:|:---:|
|appId|是|leancloud上的appId|null|
|appKey|是|leancloud上的appKey|null|
|serverURLs|否|LeanCloud的请求API([怎样获取](#serverURLs))|自动获取|
|CommentClass|是|在`leancloud`上存放**评论**的Class名称|Comment|
|CounterClass|是|在`leancloud`上存放**页面阅读量**的Class名称|Counter|
|editMode|否|是否开启评论本人可编辑模式|false|
|server|否|VueComponent，处理了`API层`和`转换层`逻辑|LeancloudComponent|

#### 注册Firebase

|参数|是否必须|说明|默认值|
|:---:|:---:|:---:|:---:|
|apiKey|是|firebase上的API网络密钥|null|
|projectId|是|firebase上的项目ID|null|
|CommentClass|是|在`firebase`上存放**评论**的Class名称|Comment|
|CounterClass|是|在`firebase`上存放**页面阅读量**的Class名称|Counter|
|editMode|否|是否开启评论本人可编辑模式|false|
|server|是|VueComponent，处理了`API层`和`转换层`逻辑，需要手动传入`backend/firebase`|/|

#### Component vue-bbs

|prop|required|description|default|
|:---:|:---:|:---:|:---:|
|nest|否|定义回复嵌套的层数|1|
|pageSize|否|评论列表分页，每页条数|10|
|offset|否|当点击回复时，自动滚动的offset，适用于`fixed`菜单的项目|0|
|[uniqStr](#uniqStr)|否|一个独立值，用于获取当前页面评论|location.origin + location.pathname|

#### Component vue-bbs-counter

|prop|required|description|default|
|:---:|:---:|:---:|:---:|
|size|否|Loading图标大小|16|
|[uniqStr](#uniqStr)|否|一个独立值，用于获取当前页面评论|location.origin + location.pathname|

#### Component vue-bbs-pageview

|prop|required|description|default|
|:---:|:---:|:---:|:---:|
|size|否|Loading图标大小|16|
|[uniqStr](#uniqStr)|否|一个独立值，用于获取当前页面评论|location.origin + location.pathname|

## 应用逻辑和扩展

`vue-bbs`逻辑分为三层式


![vue-bbs-layers](./doc/images/vue-bbs-layer.png)

第一层为`API`层，命名`APILayer.vue`，主要负责服务初始化，数据获取和错误处理

第二层为`转换接口`层，命名`ConvertLayer.vue`，负责将远程数据转换为`vue-bbs`需要的数据格式，
同时，目前为了减少`API`请求次数，采取一次性获取更多数据的策略，在转换层则需要对数据进行分页处理。

第三层为`应用层`，也就是`vue-bbs`的前端处理逻辑，在通过数据转换后，保证了数据格式的统一性。

## Q & A

### uniqStr

推荐手动传入`uniqStr`

每个页面的数据储存方式为`key:value`，因此每个页面有一个独立的字符串作为`key`，才能获取到页面的浏览数，评论数等数据，这个`key`称为`uniqStr`；

默认`uniqStr`使用当前页面`location.origin+location.pathname`，但是

1. 如果你在页面`b`想要获取页面`a`的评论数等数据，使用`location.origin+location.pathname`就会获取错误或者失败；
2. 如果两个页面的url完全相同，仅仅是`hash`不同，那么默认的`uniqStr`同样会获取失败

因此，对于每一个页面或者说每一个你定义的评论模块，建议手动提供一个`uniqStr`，这个`uniqStr`有以下特性：

1. 全局唯一
2. `uniqStr`对相同的页面一定有相同的值


### 颜色主题管理

你可以很轻松的重写`vue-bbs`的颜色配置

重写为`dark`模式
```scss
/* variable-bbs-dark.scss */

$background-color: #262626;
$primary: #1484b4;
$secondary: #a05c15;

$text-primary:rgba(255,255,255,.87);
$text-secondary:rgba(255, 255, 255, .6);
$text-muted:rgba(255, 255, 255, .18);

$separator-color: #717171;
$separator-background: #393939;
$success-color:#4caf50;
$error-color: #b71c1c;
$info-color:#2196f3;
$warning-color:#FFC107;

.serverless-bbs{
  --bbs-background-color: #{$background-color};
  --bbs-primary: #{$primary};
  --bbs-secondary: #{$secondary};
  --bbs-text-primary: #{$text-primary};
  --bbs-text-secondary: #{$text-secondary};
  --bbs-text-muted: #{$text-muted};
  --bbs-separator-color: #{$separator-color};
  --bbs-separator-background: #{$separator-background};
  --bbs-success-color: #{$success-color};
  --bbs-error-color: #{$error-color};
  --bbs-info-color: #{$info-color};
  --bbs-warning-color: #{$warning-color};
}
```

接着在你的项目中`import './variable-bbs-dark.scss'`

---
_Source: https://npm.io/package/vue-bbs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._