Giter Club home page Giter Club logo

cdx's Introduction

Stories in Ready Build Status

CDX

Reference implementation for the Connected Diagnostics API (http://dxapi.org/)

Getting Started

CDX Core Server

To start developing:

  1. Clone the repo.

  2. Install dependencies: bundle install

  3. Setup development database: bundle exec rake db:setup

  4. Setup test database: bundle exec rake db:test:prepare

  5. Setup elasticsearch index template: bundle exec rake cdx_elasticsearch:setup

  6. Run tests: bundle exec rspec

  7. Start development server: bundle exec rails s

Additionally:

  1. Import manifests: bundle exec rake manifests:load

To create an initial set of tests:

  1. Navigate to the application

  2. Create a new account and sign in

  3. Create a new institution

  4. Create a new laboratory

  5. Create a new device, choosing Genoscan model

  6. Navigate to /api/playground

  7. Select your newly created device

  8. Copy the contents of /spec/fixtures/csvs/genoscan_sample.csv into the Data field

  9. Run create message and navigate to Tests to verify the tests were successfully imported

Locations setup

Locations are obtained from the InSTEDD Location Service. You can specify a different path in config/settings/development.yml.local

Poirot

CDX uses Poirot for additional logging. You need to install zeromq library for it to work, or disable it in config/poirot.yml.

NNDD

To run notifiable diseases on development, checkout the project and symlink the custom settings files in /etc/nndd on this project:

$ cd $NOTIFIABLE_DISEASES/conf
$ ln -s $CDP/etc/nndd/settings.local.json settings.local.json
$ ln -s $CDP/etc/nndd/custom.local.scss custom.local.scss

Sync Server

In order to allow synchronization of clients through rsyns - for csv files -, you should use cdx-sync-sshd, which is a dockerized sshd container, with an inbox and outbox directoy for each client. Download and build it before continuing.

You have to mount sshd volumes pointing to the folders where you will store your authorized keys, server keys and sync directory. Although sshd-server runs standalone and independently of the cdx server, the cdx server needs to be aware of such directories:

  • SYNC_HOME: here is where files from clients wil be sync'ed. The file watcher will monitor inbox files here
  • SYNC_SSH: here is where authorized_keys file will be stored. The cdx app will write such file on this directory whenever a new ssh keys is added to a device.

By default, the cdx app assumes such directories will point to the tmp directory of the cdp app. Thus, you should start the cdx-sync-sshd docker container this way:

  cd <where you have cloned cdx-sync-server>
  export CDP_PATH=<where you have cloned this cdp repository>
  make testrun SYNC_HOME=$CDP_PATH/tmp/sync \
               SYNC_SSH=$CDP_PATH/tmp/.ssh

Sync File Watcher

Now you must start the sync filewatcher. It is based on cdx-sync-server, but already bundled into cdx app. Run the following:

 cd $CDX_PATH
 rake csv:watch

Now, whenever a new csv file enters the sshd inbox, it will be imported into the cdx platform.

Sync File Watcher - Client Side

In the client side, you will need to run another filewatcher: cdx-sync-client. It is a Windos App. Install it using its NSI installer, restart your computer, and fill the form that will prompt after first restart. You will be required to provide an activation token - you can generate it form the device manager in the CDP app.

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.