Skip to content

flybaseio/kudos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

Kudos for your site

Kudos for your site and blogs powered by Flybase

The idea is to give people Kudo support for their site or blog. Originally Kudos have been introduced by the Svbtle blog engine.

Installation

Follow these steps to setup kudos for your site.

Step 1 - Flybase account

This kudo script uses Flybase as the backend data store. As such, you first need to create a Flybase account and create a new app. You can obviously also reuse an existing one if you want so.

Step 2 - Configure Flybase

Open kudos.flybase.js and change the YOUR-API-KEY, YOUR-APP and kudos to have it point to the account you just created in step 1.

...
// replace this API-KEY with yours!!
var flybaseKudos = new Flybase("YOUR-API-KEY", "YOUR-APP", "kudos");
...
...

Step 3 - Include kudo scripts
Include the kudo scripts from the dist directory

<!-- Jquery -->
<script src="http://code.jquery.com/jquery-2.2.4.min.js" integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script>
<!-- Flybase -->
<script src="https://cdn.flybase.io/flybase.js?latest=1"></script>
<!-- Kudos script -->
<script type="text/javascript" src="https://cdn.flybase.io/kudos/kudos.js"></script>
<script type="text/javascript" src="https://cdn.flybase.io/kudos/kudos.flybase.js"></script>
<link rel="stylesheet" href="https://cdn.flybase.io/kudos/kudos.css">

Note that you need to have jQuery as well.

Step 4 - Add HTML snippet
As the last step include the following snippet

<figure class="kudo"></figure>

in your DOM where you'd like to have the kudo element appear and initialize it by invoking

$('figure.kudo').kudoable({
	dataStore: window.flybaseStorage
});

That's it. You should be ready to go.

Issues, Bugs, Enhancements..

Simply use GitHub's issues. PRs are welcome as well.

Credits

Credits have to be given to Amit Upadhyay who provided the original Svbtle independent Kudo implementation by using Parse as the backend service.

About

Kudos for your site and blogs powered by Flybase

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published