Giter Club home page Giter Club logo

node-metakit's Introduction

metakit

npm version

A toolkit to handle storage, playback and distribution of structured alphanumerical data. It is written in ES6 JavaScript for use with Node.js, uses LMDB and (soon) HDF5 to store data and provides realtime data playback through OSC over various transports, such as UDP, TCP and WebSocket.

Setup

๐Ÿš€ Tested on:

  • macOS 10.11 & 10.12
  • Ubuntu 14.04
  • Windows 8.1

Add to project

npm install --save metakit

Prerequisites

Node.js >= v9.0.0

Build tools

macOS

Build Status

xcode-select --install

Ubuntu 14.04

Build Status

sudo apt-get install build-essential gcc-4.9 g++-4.9
export CC=gcc-4.9 && CXX=g++-4.9

Windows

Build status

Install required software (Visual Studio 2015 and MinGW) manually, or use this fetch script gist:

npm install bluebird node-wget-promise fs-extra
curl -fsSL https://gist.githubusercontent.com/dasantonym/74a15caa27a93ab20903badba94783b5/raw/mtk-dl-dependencies.js | node -r bluebird

Then install node related build tools:

npm i -g windows-build-tools node-gyp mocha
npm config set msvs_version 2015 --global

Optional features

HDF5 library

Adds HDF5 compatibility in addition to LMDB. Needs a rebuild of the project, not (currently) available through NPM.

Note: This is not yet implemented as a proper build option, so for now don't bother reading any further.

Before rebuild, add the hdf5 module with npm i hdf5, then uncomment the HDF refs in src/convert/index.js and src/output/index.js and rebuild (see below).

Development

Maintainability Greenkeeper badge Dependency Status

Before pushing changes, please make sure to lint the code using npm run eslint.

Build project

Transpiles ES6 code and copies assets to dist.

npm run build

Release

Cleans dist, lib and install and lints the code before building.

npm run release

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.