Skip to content
This repository has been archived by the owner on Jul 5, 2019. It is now read-only.

Home

Jump to bottom
Vot Z edited this page May 11, 2018 · 7 revisions

Welcome to the Citation Gecko wiki!

Starting the app

  1. Clone the repo

  2. Inside of repo root directory run npm install

  3. Run node server.js

  4. The application is running at http://localhost:3000

Note: You have to provide an API key for Microsoft Academic service in public/apikeys.js in the format of { key: 'qwertyuiop' }.

API

Citation Gecko exposes an API that serves the data used to drive the visualisations.

Currently visible endpoints:

  • /api/v1/getCitedBy?doi=...

Data

The data used here is based on a dump from CrossRef.

That data is then inserted into a DynamoDB table with two columns: citeTo and citeFrom. Importing it into Dynamo makes the data queryable.

citeFrom indicates the document that's citing a citeTo document.

Note: You will need to have your AWS keys specified in ~/.aws/credentials.

Ingest process

The ingest process depends on a tsv file (provided as part of eLife Innovation Sprint 2018). Going forward this will use a file with incremental changes (to be executed with a cron job).

The ingest process is kicked off by running node dynamo/ingestData.js.

The process chunks the data to be imported into batches of 25 in order to send as many data rows at once as AWS will allow.

Clone this wiki locally