Skip to content

An easy to use JavaScript dashboard builder for event tracking

License

Notifications You must be signed in to change notification settings

keen/dashboard-builder

Repository files navigation

Keen Dashboard Builder

Slack

Build status

CircleCI

Install

For npm package manager

npm install keen-dashboard-builder --save

For yarn

yarn add keen-dashboard-builder

Example

const myDashboardBuilder = new DashboardBuilder({
  container: '#app-container',
  keenAnalysis: {
    config: {
      projectId: 'YOUR_PROJECT_ID',
      masterKey: 'YOUR_MASTER_KEY',
      protocol: 'https',
      host: 'api.keen.io'
    }
  },
  keenWebHost: 'keen.io' // optional, the default is window.location.host
});

React component

https://github.com/keen/react-dashboards

npm scripts

List of useful commands that could be used by developers.

Command Description
lint run linter against current application codebase.
test run unit tests against current application codebase.
circular run scripts responsible for the detection of circular dependencies between files.
commit run commit command line interface.
prettier run code formatter process against current codebase.

commit

This project uses Conventional Commits to enforce common commit standards.