Giter Club home page Giter Club logo

notestream-api's Introduction

notestream-api

๐Ÿšฐ This microservice is responsible for ingesting patient encounter audio (and other data) and converting it into output.

This is done via a real-time streaming (using RxJS). The API is exposed via a Socket.io websocket API.

Running it locally

> โš ๏ธ This service makes use of private npm packages, so you'll need to be authenticated to use our company's private npm registry.

### Service dependencies
This service uses other microservices as dependencies.  You'll need to run those locally or connect to a running cluster.  The URLs are provided as environment variables.  These include:
- The GraphQL API (and its dependencies)
- The STT API (and its dependencies)

### .env file
This project receives configuration inputs via the `dotenv` package.
```bash
cp local.env
.env

โš ๏ธ You'll need to fill in the blanks. Some of the environment variables include secret keys that are not tracked in .git.

Run the app

yarn dev

Testing the API

With the app running, you can simulate a real stream using this package's cli tools:

yarn cli from-file --audio-file-id 60621d23347140dc6007dba2
# run a stream for 30 seconds from a sample audio file
yarn cli from-stream --take 30 --save-windows --save-words

For the full list of available options, see ./scripts/notestream/index.js.

Alternatively, you can use the react-stt or react-admin apps as user interfaces to run and analyze data.

notestream-api's People

Contributors

bfla avatar ahomatthew avatar semantic-release-bot 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.