GithubHelp home page GithubHelp logo

dmahajan980 / intermine-registry Goto Github PK

View Code? Open in Web Editor NEW

This project forked from intermine/intermine-registry

0.0 1.0 0.0 12.13 MB

Registry to store and browse all known instances of InterMine. Developed during GSoC 2017 by Leonardo Kuffo

Home Page: http://registry.intermine.org

License: GNU Lesser General Public License v2.1

JavaScript 48.22% CSS 37.71% HTML 14.07%

intermine-registry's Introduction

InterMine Registry

InterMine Registry is a place where all the up-to-date instances information is stored and can be consumed by applications like Blue Genes, iOS, InterMine R, the friendly mine tool or available to everyone who needs it. The core of InterMine Registry is its RESTful API. Running over Node.js integrated with MongoDB, it contains methods (endpoints) to administer the instances on the registry (add, update & delete) and search among them. Furthermore, InterMine Registry also includes a nice fully responsive front-end web application, from which everyone can see all the InterMine instances and search among them.

GSoC 2017

InterMine registry was entirely implemented and developed as a GSoC 2017 program project by the student Leonardo Kuffo. Click here to find all of Leonardo's contributions for the project as evidence of his work.

Registry API

The core of the InterMine Registry App is the restFUL API. It contains endpoints to search and administer instances. These endpoints can be reached through the following base path: http://intermine.org/registry/service/

  • POST /instances Add an instance to the registry.
  • GET /instances Get all the instances from the registry.
  • GET /instances/{instanceIdOrName} Get an instance by its ID or Name.
  • PUT /instances/{instanceId} Update an instance.
  • DELETE /instances/{instanceId} Deletes an instance.
  • PUT /synchronize Update the branding & version information of every instance.
  • PUT /synchronize/{instanceIdOrName} Update the branding & version information of the specified instance.

You can check the detailed API documentation for more information and testing.

Installation

Please visit getting started

Configure the API Docs

The API-DOCS are generated based on the swagger.json file in the repository. In order for the API-DOCS to work correctly, on this file you have to specify the "HOST" and the "SCHEME" of the app (http or https).

Detailed Documentation

For more in-deep information about the code, and detailed guidelines on the project, please, visit the following link.

intermine-registry's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.