PaperBadger

Exploring the use of digital badges for crediting contributors to scholarly papers for their work

As the research environment becomes more digital, we want to test how we can use this medium to help bring transparency and credit for individuals in the publication process.

This work is a collaboration with publishers BioMed Central (BMC) and the Public Library of Science (PLoS); the biomedical research foundation, The Wellcome Trust; the software and technology firm Digital Science; the registry of unique researcher identifiers, ORCID; and the Mozilla Science Lab.

Getting Started

Project Setup

Clone PaperBadger and enter the directory: git clone https://github.com/mozillascience/PaperBadger && cd PaperBadger
Install PaperBadger's Node dependencies: npm install
If you would like to override the default, create .env file in your favourite text editor.

PORT, SESSION_SECRET, BADGES_ENDPOINT, BADGES_KEY, BADGES_SECRET, BADGES_SYSTEM, ORCID_AUTH_CLIENT_ID, ORCID_AUTH_CLIENT_SECRET, ORCID_AUTH_SITE, ORCID_AUTH_TOKEN_PATH and ORCID_REDIRECT_URI environment variables are set to the correct values. PORT can be any available port. If you would like to develop against the hosted custom badgekit-api we have running specificaly for PaperBadger testing, your environment values should look this:

    # default port is 5000
    export PORT=5000
    export SESSION_SECRET=USE_SOMETHING_GOOD_LIKE_puUJjfE6QtUnYryb

    # Badges
    export BADGES_ENDPOINT=http://badgekit-api-sciencelab.herokuapp.com/
    export BADGES_KEY=master
    export BADGES_SECRET=#############
    export BADGES_SYSTEM=badgekit

    # ORCID Auth
    export ORCID_AUTH_CLIENT_ID=#############
    export ORCID_AUTH_CLIENT_SECRET=#############
    export ORCID_AUTH_SITE=#############
    export ORCID_AUTH_TOKEN_PATH=#############
    export ORCID_REDIRECT_URI=#############

Ask @acabunoc for ones marked ###########. Our custom BadgeKit API code can be found here.

Run npm start, and open up http://localhost:5000/ in your favourite web browser!

Using the Widget

Researchers earn badges for their specific contributions to an academic paper. A researcher who worked on investigation earns a prestigious investigation badge for that paper.

The PaperBadger widget enables anyone to easily display badges on any website by including just a few lines of script with the relevant doi (digital object identifier) and a designated <div> in your view file. Authors can add the script to their own sites to display badges earned, while publishers can use the script to display all badges associated with a paper:

To use the widget on your own site, include a <div> with your custom class in your view file, for example: <div class="my-container"></div>
Above the closing <body> tag, add
<script type="text/javascript"> var script = document.createElement("script"); script.type = "text/javascript"; script.src = "https://badges.mozillascience.org/widgets/paper-badger-widget.js"; document.write(decodeURIComponent("%3Cscript src='https://badges.mozillascience.org/widgets/paper-badger-widget.js' type='text/javascript'%3E%3C/script%3E")); </script>
In your scripts, include your custom class name as the value for the "container-class" key, for example:

    <!DOCTYPE html>

    <html>
    <head>
    <title>Paper view snippet example | Paper Badger</title>
    </head> 
    <body>

    <div class="my-container"></div>

    <script type="text/javascript">
       var script = document.createElement("script");
       script.type = "text/javascript";
       script.src = "https://badges.mozillascience.org/widgets/paper-badger-widget.js";
       document.write(decodeURIComponent("%3Cscript src='https://badges.mozillascience.org/widgets/paper-badger-widget.js' type='text/javascript'%3E%3C/script%3E"));
    </script> 
    <script> 
        var conf={"article-doi": "10.1186/2047-217X-3-18", "container-class": "my-container"};
        showBadges(conf);
    </script>
    </body>
    </html>

Contributing

Project Roadmap: #17

Please review our contributing guidelines here

Want to help? Drop us a line in this issue.

API Endpoints