Orsini

About

This repository contains the code for the Orsini backend module of the Fast Data Collection project.

Table of contents

• Orsini
  • About
• Table of contents
• Status
• Features
• How to install and run this application
  • Prerequisites
  • Installing and running a test locally
• Author and Acknowledgements

Status

This is currently a work in progress in its early stages. Features will be added in frequently.

Features

• Acquire oscillography data from a Kafka stream and parse it to working memory objects
• Beams the parsed data to clients via a web-socket implemented with socket.io

How to install and run this application

Prerequisites

To run this code you will need the latest versions of Node.js and Yarn installed on your machine.

Installing and running a test locally

First you will need to have a Kafka topic set up and running on address localhost:9092. Then, run the following commands:

# Clone this respository
$ git clone <https://github.com/Gabriel-f-r-bojikian/orsini-backend.git>

# Move into the newly created folder
$ cd orsini

# Install all dependencies
$ npm install

# Run the mock data generator
$ npm run integrationTest

# Run the back-end server
$ npm run index

Author and Acknowledgements

Autorship attribuition: Gabriel Bojikian

My links for contact are: