1.0.0 • Published 6 years ago

mapdjs v1.0.0

Weekly downloads
1
License
Apache-2.0
Repository
github
Last release
6 years ago

MapD Connector

A JavaScript library for connecting to a MapD GPU database and running queries.

alt text

Quick Start

yarn
npm run build
npm run docs # opens API docs in your browser.

Documentation

Visit our API Docs

Example

Open example.html in your browser for a basic query call.

Testing

Everything in MapdCon should be unit-tested and linted. You can find these tests in /test.

The linter and all tests run on

npm test

Linting

It's our eventual goal to fully lint the files in mapd-con/src. Try to write libraries/mapd-con using the projects/dashboard-v2 Es6/7 style to make this goal easier to achieve.

Scripts

CommandDescription
npm run buildCreates /dist folder and runs webpack script
npm run cleanRemoves node modules, dist, and docs
npm run docsCreates and opens docs
npm run lintRuns lint
npm run testRuns linting and unit tests
npm run test:unitRuns mocha unit tests

Contributing

Interested in contributing? We'd love for you to help! Check out Contributing.MD