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: 7 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 (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T15:13:58.000Z (9 months ago)
• Last Synced: 2024-10-29T18:08:18.733Z (8 months ago)
• Topics: claps, kudos, medium
• Language: JavaScript
• Homepage: http://applause-button.com/
• Size: 3.74 MB
• Stars: 426
• Watchers: 7
• Forks: 41
• Open Issues: 20
• 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)

[![npm latest version](https://img.shields.io/npm/v/applause-button/latest.svg)](https://www.npmjs.com/package/applause-button)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

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

**NOTICE:** The free and hosted version of this service is no longer operational. If you want to use the applause button on your website you are encouraged to host the back-end yourself using the code from the following repo: https://github.com/ColinEberhardt/applause-button-server

## 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/);

## Browser Support

All browsers with

[partial support of Custom Elements](https://caniuse.com/custom-elementsv1); check current state at

[Browserslist](https://browsersl.ist/#q=partially+supports+custom-elementsv1).

## Development

![Node LTS](https://img.shields.io/node/v-lts/applause-button?logo=nodedotjs)

Clone this repo then install dependencies via yarn:

```shell

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 the code and start watching the `src` folder for changes as follows:

```shell

yarn watch

```

Then run the following command in another terminal, to serve a test page containing an applause-button:

```shell

yarn test:serve

```

Navigate to http://localhost:8081 to view the test page; remember to refresh the page after code changes.

### Releases

All releases are created automatically via

[semantic release](https://github.com/semantic-release/semantic-release)

running as a GitHub workflow.

## 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)]