/posthog.com

Official docs, website, and handbook for PostHog.

Primary LanguageTypeScriptOtherNOASSERTION

PostHog.com - Docs, Website, and Handbook

This is the repository for the PostHog website, which includes our Docs and Handbook.

Please feel free to suggest any changes. See our contributing guide for more information.

Quick Start

  1. Pre-Installation

    Install Node and Yarn.

    npm install --global yarn

  2. Start Developing

    Clone the repo then navigate into your new site’s directory, install the site dependencies, and start it up.

    cd posthog.com/
yarn
yarn start

    Tip: Seeing a discrepancy between local development and staging/production? Preview the production build locally by running gatsby build && gatsby serve

  3. Open the Source Code and Start Editing!

    Your site is now running at http://localhost:8001!

    Note: You'll also see a second link: http://localhost:8001/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

If you are using Apple M1 (read this for more):

rm -rf ./node_modules
brew install vips
yarn install

It is also possible to use docker:

docker run -it --rm \
    -w /app -v "$PWD":/app \
    -p 8000-8001:8000-8001 \
    -e INTERNAL_STATUS_PORT=8001 \
    node:14-slim \
    sh -c 'yarn && yarn start'

Working on /docs/api?

  1. Create a personal API key in PostHog
  2. export POSTHOG_APP_API_KEY=key
  3. yarn start

Questions?

Join our Slack community.