Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caibingcheng/orlike
一款博文点赞插件
https://github.com/caibingcheng/orlike
blog leancloud vercel
Last synced: about 2 months ago
JSON representation
一款博文点赞插件
- Host: GitHub
- URL: https://github.com/caibingcheng/orlike
- Owner: caibingcheng
- License: bsd-3-clause
- Created: 2021-05-26T12:30:23.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-24T11:52:17.000Z (almost 3 years ago)
- Last Synced: 2024-10-29T03:08:36.910Z (about 2 months ago)
- Topics: blog, leancloud, vercel
- Language: Python
- Homepage: https://orlike.vercel.app
- Size: 77.1 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OrLike
使用LeanCloud, 部署在vercel的博客点赞插件, 保障安全.
当前功能:
- [x] 分离APPID/APPKEY, 保护账号安全
- [x] 使用随机用户ID, 不保存用户其他信息, 保障用户隐私
- [x] 支持设置用户过期时间
- [x] 支持取消点赞/踩
- [x] 将orlike发布为pipy包, 方便自动升级
- [x] 加载动画
- [x] 自定义图标和CDN
# Branch
- server: server端代码
- client: client端代码
- master: demo
# Deployment
在这里可以将OrLike部署到你的Vercel账户上.
[](https://vercel.com/import/project?template=https://github.com/caibingcheng/orlike-vercel)
我们更推荐使用这个[**零配置的例子**](https://github.com/caibingcheng/orlike-vercel).
# Usage
在你期望嵌入```OrLike```的页面加入以下链接:
```JavaScript
```
当然, 也可以使用自己的CDN. 本项目也依赖JQuery, 所以别忘记引用JQuery:
```JavaScript
```
接下来, 在你期望嵌入```OrLike```的位置加上一个```div```标签, 并且加上```class```或者```id```:
```HTML
```
然后在合适的地方初始化```OrLike```:
```HTML
new OrLike({
serverUrl: "https://orlike.vercel.app/",
el: ".orlike-box",
days: 30,
icon: {like: "fa fa-heart", dislike: false},
style: "https://cdn.jsdelivr.net/gh/caibingcheng/orlike@client/orlike.min.css",
});
```
> 尽管可以使用公共的serverUrl, 但是更推荐使用私有的serverUrl, 这样更容易保证数据安全.
目前初始化需要的参数:
- ```serverUrl```: **必填**, Vercel服务地址
- ```el```: **必填**, 放```orlike```的```div```名字(```class```或```id```)
- ```days```: 可选, 用户id保存的时间, 默认是30天
- ```icon```: 可选, 自定义点赞和踩的图标, 不填写这是默认, 如果是false, 则不显示对应的按扭
- ```style```: 可选, 可自定义样式, 如果不填写, 则使用默认CDN
- ```ifont```: 可选, 可自定义font-awesome CDN, 如果不填写, 则使用默认CDN
到此为止, 本地工作已经做完了, 现在需要创建LeanCloud账户, 可以参考[Valine](https://valine.js.org/quickstart.html)的配置方法.
创建账户并且新建应用之后， 需要**给应用添加一个名为```OrLike```的class**, 并且设置**读写权限为所有用户**, 然后再拿到LeanCloud的```APP ID``` 和 ```APP Key```填入到Vercel的环境变量.
- ```APPID``` 对应 ```APP ID```
- ```APPKEY``` 对应 ```APP Key```
然后部署OrLike就可以正常工作了.
# Todo & Contributes
项目初期, 还有很多想象空间, 加油↖(^ω^)↗
- [ ] 提供点赞/踩排名