applause-button
v4.0.3
Published
A zero-configuration button for adding applause / claps / kudos to web pages and blog-posts
Downloads
8,471
Readme
Applause Button
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:
<head>
<!-- add the button style & script -->
<link rel="stylesheet" href="dist/applause-button.css" />
<script src="dist/applause-button.js"></script>
</head>
<body>
<!-- add the button! -->
<applause-button style="width: 4rem" />
</body>The above will render an applause button, persisting claps and clap counts.
For more information, visit the project website;
Browser Support
All browsers with partial support of Custom Elements; check current state at Browserslist.
Development
Clone this repo then install dependencies via yarn:
yarnUse 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:
yarn watchThen run the following command in another terminal, to serve a test page containing an applause-button:
yarn test:serveNavigate 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 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]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]