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.

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 pull
docker-compose up -d

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 Jupyter Notebook environment to demonstrate the open model hub and Objectiv Bach
  • objectiv_metabase A Metabase (OSS BI tool) environment to share and visualize your findings
Objectiv Pipeline

Exploring & modeling data

This demo includes example notebooks to demonstrate what Objectiv can do:

To explore the example notebooks, open the following URL in your browser:

http://localhost:8888/lab/tree/basic-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. Both notebooks will show the new events if you rerun any of the cells.

Accessing Metabase

To view the data that has been put out to Metabase, open the following URL in your browser:

http://localhost:3000/
  • Username: demo@objectiv.io
  • Password: metabase1

Next Steps

We hope you enjoyed playing around with Objectiv. You can use docker-compose down to stop and remove the running containers properly.

If you want to start using Objectiv for your own project, you'll want to set up a Collector and a data store first. Follow this guide to get started.

info

Want to test Objectiv on your own app/website without setting up a Collector and data store? Get a Launchpad

To learn more about tracking & modeling with Objectiv, or about the open taxonomy, check out the rest of the Docs:

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