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
curl -o docker-compose.yaml https://raw.githubusercontent.com/objectiv/objectiv-analytics/main/docker-compose.yaml
docker-compose up -d
This will spin up the following containers:
objectiv_websiteA local version of the objectiv.io website, instrumented with the Objectiv Tracker
objectiv_collectorAn Objectiv Collector to validate & store event data from the tracker
objectiv_postgresA PostgreSQL database, pre-filled with anonymized demo user data
objectiv_notebookA Jupyter Notebook environment to demonstrate Objectiv Bach and the open model hub
objectiv_metabaseA Metabase (OSS BI tool) environment to share and visualize your findings
Exploring & modeling data
This demo includes two notebooks to demonstrate what Objectiv can do:
open_model_hub_demo.ipynbDemonstration of using the open model hub to build model stacks
open-taxonomy-how-to.ipynbDemonstration of using the Objectiv Bach modeling library
To explore the notebooks, open the following URL in your browser:
For detailed modeling instructions, check out our modeling docs.
To generate event data yourself, simply go to the local version of the objectiv website and click around:
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.
To view the data that has been put out to Metabase, open the following URL in your browser:
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.
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.