Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 5.53 KB

README.md

File metadata and controls

79 lines (58 loc) · 5.53 KB
Raw

Research Software Directory DOI Admin tests Frontend tests Backend tests Integration Tests Check Markdown links

Research Software Directory

What is it?

The Research Software Directory is a content management system that is tailored to research software.

The idea is that institutes for whom research software is an important output, can run their own instance of the Research Software Directory. The system is designed to be flexible enough to allow for different data sources, database schemas, and so on. By default, the Research Software Directory is set up to collect data from GitHub, Zenodo, Zotero, as well as Medium blogs.

For each software package, a product page can be created on the Research Software Directory if the software is deemed useful to others.

What the Research Software Directory can do for you

The Research Software Directory:

  1. presents software packages alongside the context necessary for visitors to understand how the software can help them
  2. makes scientific impact of research software visible in a qualitative way
  3. provides automatically generated citation metadata in a variety of reference manager file formats, for easy citation
  4. improves findability of software packages by applying Search Engine Optimization techniques such as schema.org metadata. This helps search engines understand what a given software package is about, thus improving ranking of search results
  5. provides aggregated insights through a metrics dashboard, helping to make more accurate and more timely business decisions
  6. provides metadata about its software packages via OAI-PMH, the standard protocol for metadata harvesting. Digital libraries and other services can use this feature to automatically update their records with data about the software packages published in the Research Software Directory.
  7. provides all of its data via a JSON API
  8. integrates with third-party services such as Zotero (reference manager), Zenodo (archiving), GitHub (code development platform)

Examples

  1. https://research-software.nl
  2. https://software.process-project.eu

Try it out

Requirements

  1. You'll need a minimum of about 3 GB free disk space to store the images, containers and volumes that we will be making.
  2. Linux OS (we use Ubuntu 18.04)
  3. docker (v19.03 or later)
  4. docker-compose (v1.26 or later)
  5. git (v2.21 or later)

Instructions

To quickly get a running Research Software Directory up and running on your local machine do the following

  1. Fork this repo to your own GitHub organization or GitHub profile and clone it

  2. Start the complete stack using

    cp rsd-secrets.env.example .env
docker-compose build
docker-compose up

Go to http://localhost (disregard certificate warning) to see the Research Software Directory website. You should be able to see all non-authenticated pages, but editing data or harvesting data from external sources won't work. To bring up the website with all bells and whistles, refer to selected resources from the list below.

Further resources

  1. Entering data about your software in an existing instance
  2. Configuring your instance to use your own data sources
  3. Changing the look and feel
  4. Hosting your instance online
  5. Running an instance of the Research Software Directory in production
  6. Finding your way: Research Software Directory services
  7. Documentation for developers
  8. Documentation for maintainers
  9. Security concerns
  10. Contributing