https://github.com/nielsole/kudos
A fast, simple and self-hosted like button
https://github.com/nielsole/kudos
blogging like-button
Last synced: 4 months ago
JSON representation
A fast, simple and self-hosted like button
- Host: GitHub
- URL: https://github.com/nielsole/kudos
- Owner: nielsole
- License: mit
- Created: 2016-11-03T20:18:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T17:09:47.000Z (about 2 years ago)
- Last Synced: 2025-01-17T07:51:55.536Z (over 1 year ago)
- Topics: blogging, like-button
- Language: Go
- Homepage:
- Size: 86.9 KB
- Stars: 15
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kudos - A simple like button that can be self-hosted
Kudos is similar to a like. By simply hovering over the button for a couple of seconds, a counter is inreased.
[Example](https://www.niels-ole.com/kudos/blog/2016/11/04/now-with-kudos.html)
## Quickstart
1. Download `kudosplease.min.js` and `kudosplease.css` from the `frontend` folder
2. Embed CSS and JS on your website
```
```
3. Create the widget: `
`
4. Create the JS object:
```
new KudosPlease({
el : '.kudos',
duration : 1500,
persistent : true,
status : {
alpha: 'fontelico-emo-shoot',
beta: 'fontelico-emo-shoot',
gamma: 'fontelico-emo-beer'
}
});
```
## Self-Hosting
You need to change the API endpoint stored int the JavaScript. Simply search kudosplease.min.js for `kudos.niels-ole.com` and replace it with your API endpoint.
Kudos requires a redis database that stores the state.
Building the binary is easy: `go build -o kudos .`
```
Usage of ./kudos:
-admin-port string
Admin listen port; Provides metrics and debugging (default ":8081")
-port string
Listening port (default ":8080")
-redis-address string
redis host and port (default "localhost:6379")
-redis-db int
redis db to use
-redis-password string
redis password
```
### Docker
```
registry.gitlab.com/nielsole/kudos/kudos
```
### From source
```
go build main.go
```
## Contributors / History
I really liked http://kudosplease.com/ but their backend was really slow making it unusable, so I wrote my own.
Thanks to [Tim Pietrusky](https://github.com/TimPietrusky/) for creating kudos and publishing it under OSS.
## Roadmap / Ideas
* Ensure compatibility with different frontends for example [Get Claps](https://getclaps.app/) whose frontend is even closer to a like button.