Skip to main content

Quickstart Guide

This quickstart guide will show you how to spin up a fully functional Objectiv demo pipeline. It includes everything you need to test drive Objectiv locally.

Looking for a local development setup?

If you just want the Collector and a data store without the demo data, website and notebook, follow this guide.

Running Objectiv Dockerized

Assuming you have Docker and Curl installed, run the following commands:

curl -o docker-compose.yaml https://raw.githubusercontent.com/objectiv/objectiv-analytics/main/docker-compose.yaml
docker-compose up

This will spin up the following containers

  • objectiv_website A local version of the objectiv.io website, instrumented with the Objectiv Tracker
  • objectiv_collector An Objectiv Collector to validate & store event data from the tracker
  • objectiv_postgres A PostgreSQL database, pre-filled with anonymized demo user data
  • objectiv_notebook A demo Notebook with the Objectiv Bach modeling library to explore and model the demo data
Objectiv Pipeline

The initial startup may take a bit longer because the image is quite big (~2GB) and needs to be downloaded first.

Exploring the data

To explore the data in the demo notebook, go to:

http://localhost:8888/lab/tree/product_analytics.ipynb?token=objectiv

For detailed modeling instructions, check out our modeling docs.

Generating Events

To generate event data yourself, simply go to the local version of the objectiv website and click around:

http://localhost:8080/

When you trigger an event, you can see a request show up in your docker logs. If you used a terminal to spin up the containers, it shows there as well.

info

Please note that all events have a UTC timestamp. To see/use your new events in the Demo Notebook, just rerun the 'Explore the data' cell.

Next Steps

We hope you enjoy playing around with Objectiv. If you want to learn more about tracking & modeling with Objectiv, or about the open taxonomy, check out the rest of the Docs:

You can use docker-compose down to stop and remove the running containers properly.

If you have any questions or feedback, please join us on Slack.