Quick Start for UsersInstall with
npm install @mapd/connector. Then import
DocumentationVisit our API Docs
ExampleOpen example.html in your browser for a basic query call.
Quick Start for Developers
yarn npm run build npm run docs # opens API docs in your browser.
TestingEverything in MapdCon should be unit-tested and linted. You can find these tests in
The linter and all tests run on
LintingIt's our eventual goal to fully lint the files in
mapd-con/src. Try to write
projects/dashboard-v2Es6/7 style to make this goal easier to achieve.
ScriptsCommand | Description --- | ---
npm run build| Creates
/distfolder and runs
npm run clean| Removes node modules, dist, and docs
npm run docs| Creates and opens docs
npm run lint| Runs lint
npm run test| Runs linting and unit tests
npm run test:unit| Runs mocha unit tests