Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/abought/paperbadger

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

https://github.com/abought/paperbadger

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ✓
    DOI references
    Found 9 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: science.org, plos.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

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

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Fork of mozillascience/PaperBadger
Created almost 11 years ago · Last pushed almost 11 years ago
Metadata Files
Readme Contributing License

README.md

PaperBadger Build Status

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), Ubiquity Press (UP) 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.

Proposed Workflow / Implementation

Getting Started

Project Setup

  1. Clone PaperBadger and enter the directory: git clone https://github.com/mozillascience/PaperBadger && cd PaperBadger
  2. Install PaperBadger's Node dependencies: npm install
  3. 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.

  1. 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:

Badge Preview

  1. 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>

  2. Above the closing <body> tag, add

  3. In your scripts, include your custom class name as the value for the "container-class" key, for example:

```html <!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

Owner

  • Name: Andy Boughton
  • Login: abought
  • Kind: user
  • Location: United States
  • Company: @statgen

GitHub Events

Total
Last Year

Dependencies

package.json npm
  • js-beautify ^1.5.5 development
  • jscs ^1.13.1 development
  • jshint ^2.7.0 development
  • mocha ^2.2.5 development
  • nock ^2.3.0 development
  • supertest ^1.0.1 development
  • babel-loader ^5.0.0
  • badgekit-api-client https://github.com/mozilla/badgekit-api-client/tarball/v0.2.4
  • body-parser ^1.13.2
  • connect-mongo ^0.8.2
  • es5-shim ^4.1.1
  • exports-loader ^0.6.2
  • express ~4.9.x
  • express-session ~1.11.2
  • habitat ^3.1.2
  • imports-loader ^0.6.4
  • jade ^1.10.0
  • jsx-loader ^0.13.2
  • mofo-style ^1.0.1
  • mongoose ^4.1.4
  • nodemailer ^1.4.0
  • nodemailer-ses-transport ^1.3.0
  • npm-run-all ^1.2.4
  • react ^0.13.2
  • react-checkbox-group ^0.1.9
  • react-router ^0.13.3
  • shortid ^2.2.2
  • simple-oauth2 https://github.com/ORCID/simple-oauth2/archive/MASTER_2015_06_03.tar.gz
  • webpack ^1.8.11
  • whatwg-fetch ^0.9.0