0
0
mirror of https://github.com/PostHog/posthog.git synced 2024-11-29 19:16:37 +01:00
posthog/README.md

151 lines
33 KiB
Markdown
Raw Normal View History

2021-07-16 23:14:31 +02:00
<p align="center"><img src="https://user-images.githubusercontent.com/65415371/124739522-d8393d00-df11-11eb-9741-820955887d21.png" width="1000px" /></p>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<a href='https://posthog.com/contributors'><img src='https://img.shields.io/badge/all_contributors-181-orange.svg?style=flat-square' /></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
2020-06-26 20:09:17 +02:00
<br />
2020-01-27 06:54:19 +01:00
PostHog is an open-source product analytics suite, built for developers. Automate the collection of every event on your website or app, with no need to send data to 3rd parties.
You can deploy on your own infrastructure, and PostHog plays nicely with data warehouses through plugins for import, transformation, and export.
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124739629-f43cde80-df11-11eb-9033-c5d1d7194f03.png" width="50px" />
## Quick start
It's easy and free to get started.
2020-06-26 20:09:17 +02:00
<a href="https://posthog.com/docs/self-host/overview#deploy">Deploy PostHog Self-Hosted</a> in your existing infrastructure.
2020-06-26 20:09:17 +02:00
... or use [PostHog Cloud](https://app.posthog.com/signup) if you don't need to self-host.
2020-06-26 20:09:17 +02:00
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124739888-2cdcb800-df12-11eb-8952-5be64764a7aa.png" width="50px" />
2020-06-26 20:09:17 +02:00
2020-02-14 07:00:01 +01:00
## Features
- **Event-based** analytics at a user level - capture your product's usage data to see which users are doing what in your application.
- **Product data visualizations**: [graphs](https://posthog.com/docs/features/trends), [funnels](https://posthog.com/docs/features/funnels), [user cohorts](https://posthog.com/docs/features/cohorts), [user paths](https://posthog.com/docs/features/paths), [retention tables](https://posthog.com/docs/features/retention), and [dashboards](https://posthog.com/docs/features/dashboards).
- **Complete control** over your data - [host it yourself](https://posthog.com/docs/self-host/overview#deploy) in any infrastructure.
- **Session recording** to [watch videos](https://posthog.com/docs/features/session-recording) of your users' behavior, with fine-grained privacy controls.
- **Automatically capture** [clicks and pageviews](https://posthog.com/docs/features/actions) to analyze what your users are doing without pushing events manually.
- **Feature flags** to understand the impact of new features before rolling them out more widely.
- **Heatmaps** with the [PostHog Toolbar](https://posthog.com/docs/features/toolbar).
- **Plays nicely with data warehouses** import events or user data from your warehouse by writing a simple transformation plugin, and export data with pre-built plugins - such as BigQuery, Redshift, Snowflake and S3.
- **Ready-made libraries** for **[JS](https://posthog.com/docs/integrations/js-integration), [Python](https://posthog.com/docs/integrations/python-integration), [Ruby](https://posthog.com/docs/integrations/ruby-integration), [Node](https://posthog.com/docs/integrations/node-integration), [Go](https://posthog.com/docs/integrations/go-integration)**, [Android](https://posthog.com/docs/integrations/android-integration), [iOS](https://posthog.com/docs/integrations/ios-integration), [PHP](https://posthog.com/docs/integrations/php-integration), [Flutter](https://posthog.com/docs/integrations/flutter-integration), [React Native](https://posthog.com/docs/integrations/react-native-integration), [Elixir](https://posthog.com/docs/integrations/elixir-integration) + an [API](https://posthog.com/docs/integrations/api) for anything else.
2020-02-14 07:00:01 +01:00
![PostHog dashboard screenshot](https://posthog-static-files.s3.us-east-2.amazonaws.com/Documentation-Assets/posthog-app-screenshot.png)
2020-02-14 07:00:01 +01:00
2020-06-26 20:09:17 +02:00
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124740181-74634400-df12-11eb-929c-9aa1bf060806.png" width="50px" />
2020-06-26 20:09:17 +02:00
## Event autocapture
2020-02-20 10:26:13 +01:00
<img src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Documentation-Assets/action-toolbar.gif" width="100%">
2020-02-20 10:26:13 +01:00
2020-06-26 20:09:17 +02:00
<br /><br />
<img align="left" src="https://user-images.githubusercontent.com/65415371/124739746-10d91680-df12-11eb-86cd-9aa9494e01bd.png" width="50px" />
2020-02-14 07:00:01 +01:00
## Making the most of PostHog
See [PostHog Docs](https://posthog.com/docs/) for in-depth walk-throughs on functionality.
Join our [Slack community](https://posthog.com/slack) if you need help, want to chat, or are thinking of a new feature. We're here to help - and to make PostHog even better.
2020-02-14 07:00:01 +01:00
2020-06-26 20:09:17 +02:00
<br /><br />
<img align="left" src="https://user-images.githubusercontent.com/65415371/124740290-8e048b80-df12-11eb-9c29-654c9cb4561b.png" width="50px" />
## Philosophy
2020-02-10 00:31:43 +01:00
We help you understand user behavior without losing control of your users' data.
2020-06-26 20:09:17 +02:00
In our view, third-party analytics do not work anymore in a world of cookie laws, GDPR, CCPA, and many other four-letter acronyms. PostHog is the alternative to sending all of your customers' personal information and usage data to third-parties.
2020-06-26 20:09:17 +02:00
This means you can know who is using your app, how they're using it, and where you lose users, among [many other things](https://posthog.com/features).
Our features help you: (i) understand user behavior, (ii) create hypotheses for what to build next, and (iii) release changes to your product, then go back to step (i).
2020-06-26 20:09:17 +02:00
<br /><br />
<img align="left" src="https://user-images.githubusercontent.com/65415371/124740340-9eb50180-df12-11eb-9295-e33ac2752c57.png" width="50px" />
## What's cool about this?
PostHog is the only **product-focused** open-source analytics suite, with an event and user-driven architecture that **you can host in any infrastructure**.
We are an open-source alternative to products such as Mixpanel, Amplitude, or Heap, that's designed to be more developer-friendly, with a broader range of features like session recording, heatmaps, feature flags, and plugins.
We play nicely with data warehouses - you can _import_ event or user data by writing a plugin to create transformations, or you can _export_ data by using our existing data exports to BigQuery, Redshift, Snowflake, etc. Uniquely, you can host PostHog in the same infrastructure.
2020-06-26 20:09:17 +02:00
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124740742-f94e5d80-df12-11eb-8ca9-7d2ad4f56e3d.png" width="50px" />
2020-06-26 20:09:17 +02:00
## Get started for free
<a href="https://posthog.com/docs/self-host/overview#deploy">Deploy PostHog Self-Hosted</a> in your existing infrastructure.
... or use [PostHog Cloud](https://app.posthog.com/signup) if you don't need to self-host.
2020-06-26 20:09:17 +02:00
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124740780-04a18900-df13-11eb-8a53-ad66e031b55f.png" width="50px" />
2020-06-26 20:09:17 +02:00
## Developing locally
[See our Docs for instructions on developing locally.](https://posthog.com/docs/developing-locally)
2020-05-25 16:58:06 +02:00
2020-06-26 20:09:17 +02:00
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124740842-108d4b00-df13-11eb-99f7-c36edc39b2a0.png" width="50px" />
2020-06-26 20:09:17 +02:00
2020-05-25 16:58:06 +02:00
## Contributing
We <3 contributions big or small. [See our Docs for a guide on how to get started](https://posthog.com/docs/contributing).
Not sure where to start? [Book a free, no-pressure pairing session](mailto:tim@posthog.com?subject=Pairing%20session&body=I'd%20like%20to%20do%20a%20pairing%20session!) with one of our core contributors.
2020-01-27 06:54:19 +01:00
2020-06-26 20:09:17 +02:00
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124740898-1b47e000-df13-11eb-9518-037652dceeb8.png" width="50px" />
2020-06-26 20:09:17 +02:00
## We're hiring!
Come help us make PostHog even better. We're growing fast, [and would love for you to join us](https://posthog.com/careers).
2020-06-26 20:09:17 +02:00
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124740961-2b5fbf80-df13-11eb-8075-72c6860b3a0f.png" width="50px" />
2020-06-26 20:09:17 +02:00
## Open-source vs. paid
This repo is entirely [MIT licensed](/LICENSE), with the exception of the `ee` directory (if applicable). Need _absolutely 💯% FOSS_? Check out our [posthog-foss](https://github.com/PostHog/posthog-foss) repository, which is purged of all proprietary code and features.
Premium features (contained in the `ee` directory) require a PostHog license. Contact us at sales@posthog.com for more information, or see our [pricing page](https://posthog.com/pricing).
2020-02-20 09:10:18 +01:00
2020-06-26 20:09:17 +02:00
<br /><br />
2021-07-16 23:14:31 +02:00
<img align="left" src="https://user-images.githubusercontent.com/65415371/124741011-3581be00-df13-11eb-8d9a-b44e6fe248a8.png" width="50px" />
2020-06-26 20:09:17 +02:00
2020-02-20 09:14:12 +01:00
## Contributors 🦸
2020-02-20 09:10:18 +01:00
[//]: contributor-faces
2021-08-06 17:24:24 +02:00
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<a href="https://github.com/timgl"><img src="https://avatars.githubusercontent.com/u/1727427?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/mariusandra"><img src="https://avatars.githubusercontent.com/u/53387?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/EDsCODE"><img src="https://avatars.githubusercontent.com/u/13127476?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/Twixes"><img src="https://avatars.githubusercontent.com/u/4550621?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/macobo"><img src="https://avatars.githubusercontent.com/u/148820?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/paolodamico"><img src="https://avatars.githubusercontent.com/u/5864173?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/fuziontech"><img src="https://avatars.githubusercontent.com/u/391319?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/yakkomajuri"><img src="https://avatars.githubusercontent.com/u/38760734?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/jamesefhawkins"><img src="https://avatars.githubusercontent.com/u/47497682?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/posthog-bot"><img src="https://avatars.githubusercontent.com/u/69588470?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/apps/dependabot-preview"><img src="https://avatars.githubusercontent.com/in/2141?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/bhavish-agarwal"><img src="https://avatars.githubusercontent.com/u/14195048?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/Tannergoods"><img src="https://avatars.githubusercontent.com/u/60791437?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/ungless"><img src="https://avatars.githubusercontent.com/u/8397061?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/apps/dependabot"><img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/gzog"><img src="https://avatars.githubusercontent.com/u/1487006?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/samcaspus"><img src="https://avatars.githubusercontent.com/u/19220113?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/Tmunayyer"><img src="https://avatars.githubusercontent.com/u/29887304?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/adamb70"><img src="https://avatars.githubusercontent.com/u/11885987?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/SanketDG"><img src="https://avatars.githubusercontent.com/u/8980971?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/kpthatsme"><img src="https://avatars.githubusercontent.com/u/5965891?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/J0"><img src="https://avatars.githubusercontent.com/u/8011761?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/14MR"><img src="https://avatars.githubusercontent.com/u/5824170?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/03difoha"><img src="https://avatars.githubusercontent.com/u/8876615?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/ahtik"><img src="https://avatars.githubusercontent.com/u/140952?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/Algogator"><img src="https://avatars.githubusercontent.com/u/1433469?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/GalDayan"><img src="https://avatars.githubusercontent.com/u/24251369?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/Kacppian"><img src="https://avatars.githubusercontent.com/u/14990078?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/FUSAKLA"><img src="https://avatars.githubusercontent.com/u/6112562?v=4" width="50" height="50" alt=""/></a> <a href="https://github.com/iMerica"><img src="https://avatars.githubusercontent.com/u/487
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->