node package manager

keen-explorer

Keen IO Explorer

The Keen IO Explorer is an open source point-and-click interface for querying and visualizing your event data. It's maintained by the team at Keen IO.

Check out the demo here.. Read on for instructions on how to use the Explorer on your website or in your web app and how to get set up to develop with the Explorer.

Table of Contents

  1. How to use Explorer on your site or in your app
  2. How to develop with the Explorer
  3. FAQ
  4. Contributing
  5. Tech used in this project

How to use Explorer on your site or in your app

Include the necessary files

You have three options for including the necessary Explorer files:

Option 1: Use the hosted assets from our CDN
<!-- Dependencies -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
 
<!-- Explorer Assets -->
<link rel="stylesheet" href="https://d26b395fwzu5fz.cloudfront.net/apps/keen-explorer-3.1.2.min.css">
<script src="https://d26b395fwzu5fz.cloudfront.net/apps/keen-explorer-3.1.2.min.js"></script>
Option 2: Include the files yourself

You'd need to include all of the same assets as those listed in the CDN example above. You can download the Explorer source code to get the keen-explorer.js and keen-explorer.css files (as well as the minified versions). And you can choose to include jQuery and Bootstrap however you wish, from CDNs or using downloaded copies.

Option 3: Install using NPM

This is as easy as npm install keen-explorer

Get your project ID & API keys

If you haven’t done so already, login to Keen IO to create a project for your app. You'll need a Keen IO account to create a project. The Project ID and API Keys are available on the Project Overview page. You will need these for the next steps.

Initialize the app

Somewhere on the page that you want to show Explorer you'll need to configure a Keen.js client and pass that into the initialization of a new Explorer. Here's how you do it:

<div id="keen-explorer"></div>
<script type="text/javascript">
  var myExplorer = new Keen.Explorer.App('#keen-explorer')
    .client({
      projectId: "PROJECT_ID",
      readKey: "READ_KEY",
      masterKey: "MASTER_KEY"
    })
    .persistence(true)
    .fetch();
</script> 

And that's it. You're done!

How to develop with the Explorer

  1. git clone this repository or Download the source code
  2. Navigate to the project directory and make a copy of or rename the demo file: cp demo/example_index.html demo/index.html or mv demo/example_index.html demo/index.html
  3. Configure the Keen.js client in the demo file at demo/index.html with your project ID and Keen IO API keys.
  4. Install the dependencies with npm install.
  5. Run the development script with npm run dev or export PORT=8082; npm run dev.
  6. You can now view the demo locally at http://localhost:8081/ or your specified port.

Building the project:

The project is built with Gulp.js.

  • Run npm run production from the root directory of the project to build ALL files, including the minified versions for production use.

Testing

Run Unit Tests

  • Run npm run test to run all the tests. Currently there are only unit tests.

Run In Browser Mocha Unit Tests This isn't normally required, but if you need to, you can run the tests in the browser.

  • Run a server on another port, we use http-server on port 8082
  • See the mocha unit test suite run on http://localhost:8082/test/unit/

FAQ

Is this open source Keen Explorer different than the one on keen.io? Nope! We have recently moved all our development on the Keen Explorer to this open source version.

I have questions about using the project! Where/who do I ask? If you have any questions about using this project, Explorer feel free to contact us anytime at team@keen.io.

Contributing:

To contribute to this project:

  • Fork the repo.
  • Submit a Pull Request with test coverage.
  • Follow our PR template, which includes the following sections:
 
## What does this PR do? How does it affect users?
 
## How should this be tested?
 
Step through the code line by line. Things to keep in mind as you review:
 - Are there any edge cases not covered by this code?
 - Does this code follow conventions (naming, formatting, modularization, etc) where applicable?
 
Fetch the branch and/or deploy to staging to test the following:
 
- [ ] Does the code compile without warnings (check shell, console)?
- [ ] Do all tests pass?
- [ ] Does the UI, pixel by pixel, look exactly as expected (check various screen sizes, including mobile)?
- [ ] If the feature makes requests from the browser, inspect them in the Web Inspector. Do they look as expected (parameters, headers, etc)?
- [ ] If the feature sends data to Keen, is the data visible in the project if you run an extraction (include link to collection/query)?
- [ ] If the feature saves data to a database, can you confirm the data is indeed created in the database?
 
## Related tickets?
 

Screenshots encouraged! Would an animated GIF be more informative than a screenshot? Then we recommend Recordit.

Tech used in this project

These are the major technologies used in the project.

  • ReactJS for UI Components & input handling.
  • Flux for help managing the data model layer.
  • Bootstrap for our CSS framework.
  • NPM for dependency management.
  • Browserify to compile modules for use in the browser.
  • GulpJS for a task/build runner.