https://github.com/ColinEberhardt/applause-button

A zero-configuration medium-style button for adding applause / claps / kudos to web pages and blog posts
https://github.com/ColinEberhardt/applause-button

claps kudos medium

Last synced: 3 months ago
JSON representation

A zero-configuration medium-style button for adding applause / claps / kudos to web pages and blog posts

• Host: GitHub
• URL: https://github.com/ColinEberhardt/applause-button
• Owner: ColinEberhardt
• License: mit
• Created: 2018-05-04T19:41:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-24T08:34:48.000Z (over 1 year ago)
• Last Synced: 2024-05-22T13:28:31.790Z (6 months ago)
• Topics: claps, kudos, medium
• Language: JavaScript
• Homepage: http://applause-button.com/
• Size: 614 KB
• Stars: 422
• Watchers: 7
• Forks: 39
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Applause Button

[![Backers on Open Collective](https://opencollective.com/applause-button/backers/badge.svg)](#backers)

 [![Sponsors on Open Collective](https://opencollective.com/applause-button/sponsors/badge.svg)](#sponsors) 

A zero-configuration button for adding applause / claps / kudos to web pages and blog-posts.

## Minimal example

The applause button is a custom element that can be added directly to the page. Here is a minimal example:

```html

  

  

  

  

  

```

The above will render an applause button, persisting claps and clap counts. 

For more information, visit the [project website](https://colineberhardt.github.io/applause-button/);

## Development

Clone this repo and install dependencies via yarn:

~~~

$ yarn

~~~

Use `yarn test` to run the test suite. These use Jest as the test runner, and Puppeteer as a headless Chrome instance, allowing the applause button to make API requests (with appropriate responses faked within the test code).

You can build project and start watching the `src` folder for changes as follows:

~~~

$ yarn run watch

~~~

Run `yarn test:server` to start a dev server in another process. 

### Releases

All releases are created automatically via [semantic release](https://github.com/semantic-release/semantic-release) running on Travis.

## Contributors

This project exists thanks to all the people who contribute. 



## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/applause-button#backer)]



## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/applause-button#sponsor)]