mirrors/posthog
0
0
Fork 0
mirror of https://github.com/PostHog/posthog.git synced 2024-12-01 04:12:23 +01:00
Code Issues Releases Activity
97b5d8faac
posthog/README.md
James Hawkins 5017691bab
Updated readme with heatmaps mention (#2218) 
* updated readme

- added heatmap mention
- fixed grammatical error

* minor fixes

Co-authored-by: Yakko Majuri <38760734+yakkomajuri@users.noreply.github.com>
2020-11-12 16:21:57 +01:00

247 lines
22 KiB
Markdown
Raw Blame History

<p align="center"><img src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/post-logo-800x156.svg" width="400px" /></p>
<br />
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 />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2.jpg" width="50px" />
## Quick Start
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>
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+3.jpg" width="50px" />
## Make the Most of PostHog
See [PostHog Docs](https://posthog.com/docs/) for in-depth walk-throughs on functionality.
![PostHog dashboard screenshot](https://posthog-static-files.s3.us-east-2.amazonaws.com/Documentation-Assets/app-dashboard.png)
Join [our PostHog Users Slack community](https://join.slack.com/t/posthogusers/shared_invite/enQtOTY0MzU5NjAwMDY3LTc2MWQ0OTZlNjhkODk3ZDI3NDVjMDE1YjgxY2I4ZjI4MzJhZmVmNjJkN2NmMGJmMzc2N2U3Yjc3ZjI5NGFlZDQ) 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.
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+4.jpg" width="50px" />
## Features
- **Event-based** analytics at a user level - see which users are doing what in your application.
- **Complete control** over your data - host it yourself.
- **Automatically capture** clicks and page views to do analyze what your users are doing **retroactively**.
- **Feature flags** to understand the impact of new features before rolling them out more widely
- **Heatmaps** to understand where in your app or website people are clicking
- **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)** + [API](https://posthog.com/docs/integrations/api) for anything else.
- **Beautiful 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).
- **Analytics right on your website** with the playful [PostHog Toolbar](https://posthog.com/docs/features/toolbar).
- **Super easy deploy** using Docker or Heroku.
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+3+1.jpg" width="50px" />
## Event Autocapture
<img src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Documentation-Assets/action-toolbar.gif" width="100%">
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+4+1.jpg" width="50px" />
## Philosophy
Many engineers find it painful to work out how their products are being used. This makes design decisions tough. PostHog solves that.
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.
PostHog gives you full control over all the data from your users, while allowing anyone to do powerful analytics.
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).
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+6+1.jpg" width="50px" />
## What's Cool About This?
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.
There are a few session-based open-source libraries that are nice alternatives to Google Analytics. That's not what we are focused on.
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+7+1.jpg" width="50px" />
## PostHog Cloud
You can [sign up for a free account](https://app.posthog.com/signup) on our hosted platform.
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+8+1.jpg" width="50px" />
## Deployment Options
Our suggested method for quick deployment is Heroku's one-click option:
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/posthog/posthog)
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)
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+10+1.jpg" width="50px" />
## Production Deployment
[See our Docs for production deployment options.](https://posthog.com/docs/deployment)
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+11+1.jpg" width="50px" />
## Developing Locally
[See our Docs for instructions on developing locally.](https://posthog.com/docs/developing-locally)
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+12+1.jpg" width="50px" />
## 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.
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+13+1.jpg" width="50px" />
## 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).
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+14+1.jpg" width="50px" />
## 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.
<br /><br />
<img align="left" src="https://posthog-static-files.s3.us-east-2.amazonaws.com/Website-Assets/rebrand/icons/Untitled_Artwork+2+copy+15+1.jpg" width="50px" />
## Contributors 🦸
[//]: contributor-faces
<a href="https://github.com/timgl"><img src="https://avatars1.githubusercontent.com/u/1727427?v=4" title="timgl" width="50" height="50"></a>
<a href="https://github.com/jamesefhawkins"><img src="https://avatars3.githubusercontent.com/u/47497682?v=4" title="jamesefhawkins" width="50" height="50"></a>
<a href="https://github.com/mariusandra"><img src="https://avatars2.githubusercontent.com/u/53387?v=4" title="mariusandra" width="50" height="50"></a>
<a href="https://github.com/EDsCODE"><img src="https://avatars0.githubusercontent.com/u/13127476?v=4" title="EDsCODE" width="50" height="50"></a>
<a href="https://github.com/Twixes"><img src="https://avatars3.githubusercontent.com/u/4550621?v=4" title="Twixes" width="50" height="50"></a>
<a href="https://github.com/fuziontech"><img src="https://avatars0.githubusercontent.com/u/391319?v=4" title="fuziontech" width="50" height="50"></a>
<a href="https://github.com/ungless"><img src="https://avatars2.githubusercontent.com/u/8397061?v=4" title="ungless" width="50" height="50"></a>
<a href="https://github.com/berntgl"><img src="https://avatars1.githubusercontent.com/u/55957336?v=4" title="berntgl" width="50" height="50"></a>
<a href="https://github.com/lottiecoxon"><img src="https://avatars2.githubusercontent.com/u/65415371?v=4" title="lottiecoxon" width="50" height="50"></a>
<a href="https://github.com/yakkomajuri"><img src="https://avatars2.githubusercontent.com/u/38760734?v=4" title="yakkomajuri" width="50" height="50"></a>
<a href="https://github.com/paolodamico"><img src="https://avatars1.githubusercontent.com/u/5864173?v=4" title="paolodamico" width="50" height="50"></a>
<a href="https://github.com/dar-mehta"><img src="https://avatars3.githubusercontent.com/u/10489943?v=4" title="dar-mehta" width="50" height="50"></a>
<a href="https://github.com/bitbreakr"><img src="https://avatars3.githubusercontent.com/u/3123986?v=4" title="bitbreakr" width="50" height="50"></a>
<a href="https://github.com/Tannergoods"><img src="https://avatars1.githubusercontent.com/u/60791437?v=4" title="Tannergoods" width="50" height="50"></a>
<a href="https://github.com/casio"><img src="https://avatars0.githubusercontent.com/u/29784?v=4" title="casio" width="50" height="50"></a>
<a href="https://github.com/andreipopovici"><img src="https://avatars0.githubusercontent.com/u/1143417?v=4" title="andreipopovici" width="50" height="50"></a>
<a href="https://github.com/wundo"><img src="https://avatars0.githubusercontent.com/u/113942?v=4" title="wundo" width="50" height="50"></a>
<a href="https://github.com/paulanunda"><img src="https://avatars0.githubusercontent.com/u/155981?v=4" title="paulanunda" width="50" height="50"></a>
<a href="https://github.com/arosales"><img src="https://avatars3.githubusercontent.com/u/1707853?v=4" title="arosales" width="50" height="50"></a>
<a href="https://github.com/ChandanSagar"><img src="https://avatars3.githubusercontent.com/u/27363164?v=4" title="ChandanSagar" width="50" height="50"></a>
<a href="https://github.com/wadenick"><img src="https://avatars1.githubusercontent.com/u/9014043?v=4" title="wadenick" width="50" height="50"></a>
<a href="https://github.com/jgannondo"><img src="https://avatars0.githubusercontent.com/u/28159071?v=4" title="jgannondo" width="50" height="50"></a>
<a href="https://github.com/keladhruv"><img src="https://avatars3.githubusercontent.com/u/30433468?v=4" title="keladhruv" width="50" height="50"></a>
<a href="https://github.com/grellyd"><img src="https://avatars1.githubusercontent.com/u/7812612?v=4" title="grellyd" width="50" height="50"></a>
<a href="https://github.com/rberrelleza"><img src="https://avatars0.githubusercontent.com/u/475313?v=4" title="rberrelleza" width="50" height="50"></a>
<a href="https://github.com/scottcrawford03"><img src="https://avatars1.githubusercontent.com/u/8398867?v=4" title="scottcrawford03" width="50" height="50"></a>
<a href="https://github.com/annanay25"><img src="https://avatars2.githubusercontent.com/u/10982987?v=4" title="annanay25" width="50" height="50"></a>
<a href="https://github.com/cohix"><img src="https://avatars3.githubusercontent.com/u/5942370?v=4" title="cohix" width="50" height="50"></a>
<a href="https://github.com/gouthamve"><img src="https://avatars0.githubusercontent.com/u/7354143?v=4" title="gouthamve" width="50" height="50"></a>
<a href="https://github.com/alexellis"><img src="https://avatars1.githubusercontent.com/u/6358735?v=4" title="alexellis" width="50" height="50"></a>
<a href="https://github.com/prologic"><img src="https://avatars2.githubusercontent.com/u/1290234?v=4" title="prologic" width="50" height="50"></a>
<a href="https://github.com/jgustie"><img src="https://avatars2.githubusercontent.com/u/883981?v=4" title="jgustie" width="50" height="50"></a>
<a href="https://github.com/kubemq"><img src="https://avatars0.githubusercontent.com/u/45835100?v=4" title="kubemq" width="50" height="50"></a>
<a href="https://github.com/vania-pooh"><img src="https://avatars0.githubusercontent.com/u/829320?v=4" title="vania-pooh" width="50" height="50"></a>
<a href="https://github.com/irespaldiza"><img src="https://avatars0.githubusercontent.com/u/11633327?v=4" title="irespaldiza" width="50" height="50"></a>
<a href="https://github.com/croomes"><img src="https://avatars0.githubusercontent.com/u/211994?v=4" title="croomes" width="50" height="50"></a>
<a href="https://github.com/snormore"><img src="https://avatars1.githubusercontent.com/u/182290?v=4" title="snormore" width="50" height="50"></a>
<a href="https://github.com/faik"><img src="https://avatars3.githubusercontent.com/u/43129?v=4" title="faik" width="50" height="50"></a>
<a href="https://github.com/aandryashin"><img src="https://avatars1.githubusercontent.com/u/1412461?v=4" title="aandryashin" width="50" height="50"></a>
<a href="https://github.com/andrewsomething"><img src="https://avatars0.githubusercontent.com/u/46943?v=4" title="andrewsomething" width="50" height="50"></a>
<a href="https://github.com/Ferroin"><img src="https://avatars2.githubusercontent.com/u/905151?v=4" title="Ferroin" width="50" height="50"></a>
<a href="https://github.com/cpanato"><img src="https://avatars2.githubusercontent.com/u/4115580?v=4" title="cpanato" width="50" height="50"></a>
<a href="https://github.com/cakrit"><img src="https://avatars0.githubusercontent.com/u/43294513?v=4" title="cakrit" width="50" height="50"></a>
<a href="https://github.com/dkhenry"><img src="https://avatars2.githubusercontent.com/u/489643?v=4" title="dkhenry" width="50" height="50"></a>
<a href="https://github.com/oxplot"><img src="https://avatars1.githubusercontent.com/u/483682?v=4" title="oxplot" width="50" height="50"></a>
<a href="https://github.com/marc-barry"><img src="https://avatars1.githubusercontent.com/u/4965634?v=4" title="marc-barry" width="50" height="50"></a>
<a href="https://github.com/moabu"><img src="https://avatars3.githubusercontent.com/u/47318409?v=4" title="moabu" width="50" height="50"></a>
<a href="https://github.com/nawazdhandala"><img src="https://avatars1.githubusercontent.com/u/2697338?v=4" title="nawazdhandala" width="50" height="50"></a>
<a href="https://github.com/ihcsim"><img src="https://avatars1.githubusercontent.com/u/1330522?v=4" title="ihcsim" width="50" height="50"></a>
<a href="https://github.com/maclcky132"><img src="https://avatars2.githubusercontent.com/u/55850406?v=4" title="maclcky132" width="50" height="50"></a>
<a href="https://github.com/athreyaanand"><img src="https://avatars2.githubusercontent.com/u/31478366?v=4" title="athreyaanand" width="50" height="50"></a>
<a href="https://github.com/alexearnshaw"><img src="https://avatars2.githubusercontent.com/u/29064556?v=4" title="alexearnshaw" width="50" height="50"></a>
<a href="https://github.com/Algogator"><img src="https://avatars0.githubusercontent.com/u/1433469?v=4" title="Algogator" width="50" height="50"></a>
<a href="https://github.com/callumgare"><img src="https://avatars0.githubusercontent.com/u/346340?v=4" title="callumgare" width="50" height="50"></a>
<a href="https://github.com/DannyBen"><img src="https://avatars1.githubusercontent.com/u/2405099?v=4" title="DannyBen" width="50" height="50"></a>
<a href="https://github.com/Epskampie"><img src="https://avatars0.githubusercontent.com/u/1692043?v=4" title="Epskampie" width="50" height="50"></a>
<a href="https://github.com/itsjwala"><img src="https://avatars1.githubusercontent.com/u/24763310?v=4" title="itsjwala" width="50" height="50"></a>
<a href="https://github.com/J0"><img src="https://avatars0.githubusercontent.com/u/8011761?v=4" title="J0" width="50" height="50"></a>
<a href="https://github.com/hassan11196"><img src="https://avatars3.githubusercontent.com/u/33365802?v=4" title="hassan11196" width="50" height="50"></a>
<a href="https://github.com/rasulkireev"><img src="https://avatars2.githubusercontent.com/u/8257474?v=4" title="rasulkireev" width="50" height="50"></a>
<a href="https://github.com/sjain07"><img src="https://avatars2.githubusercontent.com/u/2438605?v=4" title="sjain07" width="50" height="50"></a>
<a href="https://github.com/bhavish-agarwal"><img src="https://avatars3.githubusercontent.com/u/14195048?v=4" title="bhavish-agarwal" width="50" height="50"></a>
<a href="https://github.com/gzog"><img src="https://avatars0.githubusercontent.com/u/1487006?v=4" title="gzog" width="50" height="50"></a>
<a href="https://github.com/Tmunayyer"><img src="https://avatars2.githubusercontent.com/u/29887304?v=4" title="Tmunayyer" width="50" height="50"></a>
<a href="https://github.com/macobo"><img src="https://avatars0.githubusercontent.com/u/148820?v=4" title="macobo" width="50" height="50"></a>
<a href="https://github.com/SanketDG"><img src="https://avatars3.githubusercontent.com/u/8980971?v=4" title="SanketDG" width="50" height="50"></a>
<a href="https://github.com/14MR"><img src="https://avatars1.githubusercontent.com/u/5824170?v=4" title="14MR" width="50" height="50"></a>
<a href="https://github.com/03difoha"><img src="https://avatars3.githubusercontent.com/u/8876615?v=4" title="03difoha" width="50" height="50"></a>
<a href="https://github.com/Kacppian"><img src="https://avatars1.githubusercontent.com/u/14990078?v=4" title="Kacppian" width="50" height="50"></a>
<a href="https://github.com/iM
a"><img src="https://avatars3.githubusercontent.com/u/487897?v=4" title="iMerica" width="50" height="50"></a>
<a href="https://github.com/pedroapfilho"><img src="https://avatars2.githubusercontent.com/u/13142568?v=4" title="pedroapfilho" width="50" height="50"></a>
<a href="https://github.com/eLRuLL"><img src="https://avatars3.githubusercontent.com/u/1459486?v=4" title="eLRuLL" width="50" height="50"></a>
<a href="https://github.com/samcaspus"><img src="https://avatars0.githubusercontent.com/u/19220113?v=4" title="samcaspus" width="50" height="50"></a>
<a href="https://github.com/anoopemacs"><img src="https://avatars3.githubusercontent.com/u/12211622?v=4" title="anoopemacs" width="50" height="50"></a>
<a href="https://github.com/CaseGuide"><img src="https://avatars2.githubusercontent.com/u/33905722?v=4" title="CaseGuide" width="50" height="50"></a>
<a href="https://github.com/budnik"><img src="https://avatars0.githubusercontent.com/u/1160699?v=4" title="budnik" width="50" height="50"></a>
<a href="https://github.com/ellie"><img src="https://avatars1.githubusercontent.com/u/53315310?v=4" title="ellie" width="50" height="50"></a>
<a href="https://github.com/tirkarthi"><img src="https://avatars3.githubusercontent.com/u/3972343?v=4" title="tirkarthi" width="50" height="50"></a>
<a href="https://github.com/mrkurt"><img src="https://avatars1.githubusercontent.com/u/7724?v=4" title="mrkurt" width="50" height="50"></a>
<a href="https://github.com/manuelfcreis"><img src="https://avatars1.githubusercontent.com/u/29898180?v=4" title="manuelfcreis" width="50" height="50"></a>
<a href="https://github.com/maximmarakov"><img src="https://avatars1.githubusercontent.com/u/36736392?v=4" title="maximmarakov" width="50" height="50"></a>
<a href="https://github.com/mikeabrahamsen"><img src="https://avatars2.githubusercontent.com/u/467659?v=4" title="mikeabrahamsen" width="50" height="50"></a>
<a href="https://github.com/OriPekelman"><img src="https://avatars1.githubusercontent.com/u/138636?v=4" title="OriPekelman" width="50" height="50"></a>
<a href="https://github.com/sac0"><img src="https://avatars2.githubusercontent.com/u/20946852?v=4" title="sac0" width="50" height="50"></a>
<a href="https://github.com/sanketsaurav"><img src="https://avatars2.githubusercontent.com/u/881122?v=4" title="sanketsaurav" width="50" height="50"></a>
<a href="https://github.com/solnsubuga"><img src="https://avatars3.githubusercontent.com/u/23418080?v=4" title="solnsubuga" width="50" height="50"></a>
<a href="https://github.com/anandvenkat4"><img src="https://avatars2.githubusercontent.com/u/3582757?v=4" title="anandvenkat4" width="50" height="50"></a>
<a href="https://github.com/abhijitghate"><img src="https://avatars2.githubusercontent.com/u/11834249?v=4" title="abhijitghate" width="50" height="50"></a>
<a href="https://github.com/Jujhar"><img src="https://avatars0.githubusercontent.com/u/5521110?v=4" title="Jujhar" width="50" height="50"></a>
<a href="https://github.com/dts"><img src="https://avatars0.githubusercontent.com/u/273856?v=4" title="dts" width="50" height="50"></a>
<a href="https://github.com/rushabhnagda11"><img src="https://avatars1.githubusercontent.com/u/3235568?v=4" title="rushabhnagda11" width="50" height="50"></a>
View Git Blame Copy Permalink