mozillascience / software-discovery-dashboard

MIT License
19 stars 8 forks source link

Software Discovery Dashboard

Synopsis

This project’s objective is to create an open source web dashboard capable of searching multiple code hosting services, such as Zenodo, Figshare, and GitHub, for the benefit of the research community. The goal of this dashboard is to demonstrate the usefulness of a new metadata standard by utilizing it for easy and effective software discovery and analysis.

Links

Google Docs

EtherPad

Team Website

Getting started

To run the Software Discovery Dashboard locally, run these steps:

  1. Clone git clone git@github.com:mozillascience/software-discovery-dashboard.git && cd software-discovery-dashboard
  2. run npm run fullinstall
  3. run npm start and open up http://localhost:5000/ in your favourite web browser!

Style Guide

This project follows the Airbnb Style Guide. Included is a linter configured to enforce this style guide. It is run alongside unit tests with npm test but can also be run alone with gulp lint.

Communication

Join the conversation on Gitter.

Contributing

There are multiple ways to get involved in the project: open an issue, comment on open issues, join the conversation on Gitter (see Communication above), or fix an open issue, to name a few.

Issues marked with the help wanted tag are a great place to start. They are smaller, generally straightforward bugs or enhancements meant to provide an easy introduction to the codebase while still contributing meaningful work. They may also be conversational issues where input is greatly appreciated.

Project Leadership

Technical Lead : Luke Coy

QA Lead : Matt Mokary

Scrum Master : Stefan Neamtu

Open Source Relations / Github Guru : Adam Blaine