2021-04-21 11:36:15 +02:00
< p align = "center" > < img src = "https://posthog-public.s3.amazonaws.com/PostHog+Header.svg" width = "400px" / > < / p >
2021-03-29 19:33:31 +02:00
<!-- ALL - CONTRIBUTORS - BADGE:START - Do not remove or modify this section -->
2021-07-12 15:01:47 +02:00
< a href = 'https://posthog.com/contributors' > < img src = 'https://img.shields.io/badge/all_contributors-146-orange.svg?style=flat-square' / > < / a >
2021-03-29 19:33:31 +02:00
<!-- ALL - CONTRIBUTORS - BADGE:END -->
2020-02-20 06:25:40 +01:00
2020-06-26 20:09:17 +02:00
< br / >
2020-01-27 06:54:19 +01:00
2020-08-24 12:49:04 +02:00
PostHog provides open-source product analytics, built for developers. Automate the collection of every event on your website or app, with no need to send data to 3rd parties. With just 1 click you can deploy on your own infrastructure, having full API/SQL access to the underlying data.
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Quick+start.svg" width = "50px" / >
2020-02-09 23:39:05 +01:00
2020-08-24 12:49:04 +02:00
## Quick Start
2020-02-15 06:26:54 +01:00
2020-02-20 09:17:11 +01:00
1-click Heroku deploy:
< a href = "https://heroku.com/deploy?template=https://github.com/posthog/posthog" > < img src = "https://www.herokucdn.com/deploy/button.svg" width = "250px" / > < / a >
2020-02-15 06:26:54 +01:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Make+the+most+of+PH.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-11-12 16:21:57 +01:00
## Make the Most of PostHog
2020-06-26 20:09:17 +02:00
2020-08-24 12:49:04 +02:00
See [PostHog Docs ](https://posthog.com/docs/ ) for in-depth walk-throughs on functionality.
2020-02-14 07:00:01 +01:00
2020-08-21 21:30:04 +02:00
2020-02-14 08:06:08 +01:00
2021-04-21 23:28:37 +02:00
Join [our PostHog Users 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-20 09:36:14 +01:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Features.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-02-14 07:00:01 +01:00
## Features
2021-02-07 12:30:58 +01:00
- **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 ).
2020-08-24 12:49:04 +02:00
- **Complete control** over your data - host it yourself.
2021-02-07 12:30:58 +01:00
- **Session recording** to [watch videos ](https://posthog.com/docs/features/session-recording ) of your user 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
2020-11-12 16:21:57 +01:00
- **Feature flags** to understand the impact of new features before rolling them out more widely
2021-02-07 12:30:58 +01:00
- **Heatmaps** with the [PostHog Toolbar ](https://posthog.com/docs/features/toolbar ).
- **Plugins** to integrate your product usage data with other systems, like your CRM, or data lakes.
- **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 ) + [API ](https://posthog.com/docs/integrations/api ) for anything else.
2020-08-24 12:49:04 +02:00
- **Super easy deploy** using Docker or Heroku.
2020-02-14 07:00:01 +01:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Event+autocapture.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-08-21 21:30:04 +02:00
## Event Autocapture
2020-02-20 10:26:13 +01:00
2020-08-21 21:30:04 +02: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 / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Philosophy.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-02-14 07:00:01 +01:00
## Philosophy
2020-02-20 05:27:56 +01:00
Many engineers find it painful to work out how their products are being used. This makes design decisions tough. PostHog solves that.
2020-02-19 23:11:10 +01:00
2020-08-24 12:49:04 +02:00
In our view, third-party analytics does not work anymore in a world of cookie laws, GDPR, CCPA, and many other four-letter acronyms. There should be an alternative to sending all of your customers' personal information and usage data to third-parties like Google.
2020-02-19 23:11:10 +01:00
2020-08-21 21:30:04 +02:00
PostHog gives you full control over all the data from your users, while allowing anyone to do powerful analytics.
2020-02-14 07:00:01 +01:00
2020-08-21 21:30:04 +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/product-features ).
2020-02-14 08:30:05 +01:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/What's+cool.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-08-24 12:49:04 +02:00
## What's Cool About This?
2020-02-14 08:30:05 +01:00
2021-02-07 12:30:58 +01:00
PostHog is the only **product-focused** open-source analytics library, with an event and user-driven architecture. That means tracking identifiable (where applicable) user behavior, and creating user profiles. We are an open-source alternative to products such as Mixpanel, Amplitude, or Heap, that's designed to be more developer-friendly than them, with a broader range of features like session recording, heatmaps, feature flags and plugins.
2020-02-14 08:30:05 +01:00
2020-08-24 12:49:04 +02:00
There are a few session-based open-source libraries that are nice alternatives to Google Analytics. That's not what we are focused on.
2020-02-10 00:31:43 +01:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/PostHog+CLoud.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-08-24 12:49:04 +02:00
## PostHog Cloud
2020-02-09 23:39:05 +01:00
2020-06-11 22:48:46 +02:00
You can [sign up for a free account ](https://app.posthog.com/signup ) on our hosted platform.
2020-02-09 23:39:05 +01:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Deployment.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-08-27 16:41:08 +02:00
## Deployment Options
Our suggested method for quick deployment is Heroku's one-click option:
2020-02-09 23:39:05 +01:00
[](https://heroku.com/deploy?template=https://github.com/posthog/posthog)
2020-08-27 16:41:08 +02:00
However, PostHog can be deployed anywhere you want! Here are step-by-step tutorials we've written for deployment options using all the major cloud providers:
* [AWS ](https://posthog.com/docs/deployment/deploy-aws )
* [Microsoft Azure ](https://posthog.com/docs/deployment/deploy-azure )
* [Digital Ocean ](https://posthog.com/docs/deployment/deploy-digital-ocean )
* [Google Cloud ](https://posthog.com/docs/deployment/deploy-gcs )
* [Linode ](https://posthog.com/docs/deployment/deploy-linode )
* [Render ](https://posthog.com/docs/deployment/deploy-render )
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Production+Development.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-08-24 12:49:04 +02:00
## Production Deployment
2020-02-09 23:39:05 +01:00
2020-08-21 21:30:04 +02:00
[See our Docs for production deployment options. ](https://posthog.com/docs/deployment )
2020-02-09 23:39:05 +01:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Developing+Locally.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-08-24 12:49:04 +02:00
## Developing Locally
2020-03-06 23:20:32 +01:00
2020-08-21 21:30:04 +02:00
[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-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Contributing.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-05-25 16:58:06 +02:00
## Contributing
2020-08-21 21:30:04 +02:00
We < 3 contributions big or small . [See our Docs for a guide on how to get started. ](https://posthog.com/docs/contributing ).
2020-06-16 14:28:30 +02:00
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-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Hiring.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-06-11 22:48:46 +02:00
## We're hiring!
2020-08-24 12:49:04 +02:00
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-11 22:48:46 +02:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Open+Source+vs+Paid.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-08-24 12:49:04 +02:00
## Open-Source vs. Paid
2020-08-21 21:30:04 +02:00
2020-08-24 12:49:04 +02:00
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.
2020-08-18 11:05:30 +02:00
2020-08-24 12:49:04 +02:00
Premium features (contained in the `ee` directory) require a PostHog license. Contact us at sales@posthog.com for more information.
2020-02-20 09:10:18 +01:00
2020-06-26 20:09:17 +02:00
< br / > < br / >
2021-04-20 18:14:02 +02:00
< img align = "left" src = "https://posthog-public.s3.amazonaws.com/Contributors.svg" width = "50px" / >
2020-06-26 20:09:17 +02:00
2020-02-20 09:14:12 +01:00
## Contributors 🦸
2020-03-06 23:20:32 +01:00
2020-02-20 09:10:18 +01:00
[//]: contributor-faces
2021-03-24 10:42:17 +01:00
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
2021-07-12 15:01:47 +02:00
< 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
2021-03-24 10:42:17 +01:00
<!-- markdownlint - restore -->
<!-- prettier - ignore - end -->
2021-03-29 19:33:31 +02:00
<!-- ALL - CONTRIBUTORS - LIST:END -->
