Query Creator

The Query Creator is an open source point-and-click interface used to create Keen Query structure. It's maintained by the team at Keen IO.

Install

npm install query-creator --save

or

yarn add query-creator

Integration

<QueryCreator
  modalContainer={modalContainer}
  projectId={projectId}
  readKey={readKey}
  masterKey={masterKey}
  host={host}
  onUpdateQuery={(query) => {}}
  onUpdateChartSettings={(chartSettings) => {}}
  httpProtocol={httpProtocol}
/>

Build

The @keen.io/query-creator use two step build to address issues with CSS specificity.

Typescript

First stage is responsible for transpilation Typescript code to esnext and emiting type declarations.

Babel

Second stage is responsible for code transpilation based on supported browserlist defined in package.json file and increasing styled-components css specificity by using plugins from .babelrc file. Generator functions transformations are disabled so applications that use this package should take care of it on their own.

Project Setup

prerequisites

1. yarn - package manager
2. node - make sure it's minimum 10.x.x

steps

1. checkout repository
2. run yarn - to install project dependencies
3. create a config.js file (use config.template.js) and provide Keen credentials
4. run application in development mode yarn start

npm scripts

List of useful commands that could be used by developers. Execution in the command-line interface should be prefixed with yarn package manager.

| Command | Description | | ---------- | ---------------------------------------------------- | | lint | run linter against current application codebase. | | test | run unit tests. | | build | builds application distribution. | | prettier | run code formatter process against current codebase. |

commit

This project uses Conventional Commits to enforce common commit standards.

| Command | Description | | ------------ | ---------------------------------- | | npx git-cz | run commit command line interface. |