Giter Club home page Giter Club logo

abbrev-app's Introduction

Abbreviation App

Web app that crowd sources understanding of abbreviations used in medical context.

Requirements

Download and install the docker community edition.

Getting started

Bring up the database first:

docker-compose -f docker-compose.yml up -d --build postgres

Bring up the backend (API) and front-end (APP):

docker-compose -f docker-compose.yml up -d --build api app

Open up the browser to localhost:4002

View logs:

docker-compose -f docker-compose.yml logs --follow api app postgres

Open postgres database:

docker-compose -f docker-compose.yml exec postgres psql -U project-name project-name

Import abbreviation data

Bulk import

Assumes you have a JSON file structured in the following format:

{ abbreviation: 
  { expansions: [
      "expanded text of the abbreviation",
      ...
    ],
    sentences: [
      "sentence with an <abbreviation> somewhere",
      ...
    ]
  } 
}

Exec into the API container and run node ./scripts/import-json-data.js <path/to/abbreviations.json>

Import individual abbreviations

Assumes data is provided in the following format:

  1. An expansions text file with each expansion on a new line:
...
dipole moment
dexmedetomidine
detarium microcarpum
dietary modification
...
  1. A text file of sentences with the abbreviation marked by the <...>:
...
This is an exmaple sentence that uses the abbreviation <dm> to illustrate an example
...

To import the data, call the import-data.js script from within the API container with the abbreviation as the first parameter, then the path to the expansions text file, and finally the path to the sentences text file as follows:

node import-data.js dm ./path-to-expansions.txt ./path-to-sentences.txt

abbrev-app's People

Contributors

manased avatar mikegin avatar hamzanadeveloper avatar

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.