Giter VIP home page Giter VIP logo

disease-info's Introduction

DISEASE INFO

This project is basically for getting information about diseases from Health Organizations - WHO, CDC et al.

Getting Started

Clone the project repository by running the command below if you use SSH

git clone [email protected]:devcenter-square/disease-info.git

If you use https, use this instead

git clone https://github.com/devcenter-square/disease-info.git

Database

This project uses Mysql, if you already have it installed on your machine, you can skip to the next step.

If you don't have it installed:

Mac users

You can install it with brew update && brew install mysql

Skip this part unless you are having errors setting up your DB.

Create a config file at any location of your choice e.g

touch /usr/local/etc/my.cnf

Then type this in the file

[mysqld]
skip-external-locking

Others

Please follow the instructions here.

Setting Up

  • cd into the project directory.
  • Run bundle install
  • then rake db:create
  • then rake db:migrate

Populating the Database

Populate Database with disease info by running

rake mine_data:who

When this is done, visit the endpoint for diseases on http://localhost:3000/diseases.json to get a list of all diseases on your database.

Adding a new data scraper

The present scrapers are:

Feel free to add another scraper by first adding your rake task to the present list on lib/tasks/mine_data.rake. Then create your scraper in app/lib/scrapers. You can follow the example of the WHO scraper. If you have to add new columns to the existing Disease structure based on the data you get, feel free to do that. More importantly, add the source of your data in the more column present on the Disease object. Make sure to name space your Disease name with the source. For example Malaria from WHO is saved with name Malaria - WHO.

Available End Points

End Point Method Expected response
/diseases.json GET Gets a list of all diseases
/diseases.json?data_source=source GET Gets a list of diseases from a particular source. Available sources are; WHO
/diseases/disease_name.json GET Gets a particular disease with the supplied name

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.