posthog-demo-3000

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #go #golang #android #machine-learning #deep-learning #awesome #kubernetes #vue #ios #openai #open-source

posthog-demo-3000

(★ 16)

No description available.

posthog-demo-3000 Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# HogFlix Demo 3000

This repository allows you to spin up a demo app which has been instrumented with PostHog, and seed PostHog historic data and artifacts to provide a full-featured demo environment showcasing all features.

## Prerequisites

If you choose to run the demo entirely in your browser using GitHub Code Spaces, skip the requirements and go straight to Option 3, otherwise follow the prerequisites instructions.

To run the demo app on a Mac you'll need to set up Python 3 locally:

1. Install Xcode Command Line Tools if you haven't already: `xcode-select --install`.
2. Install the package manager Homebrew by following the [instructions here](https://brew.sh/).

After installation, make sure to follow the instructions printed in your terminal to add Homebrew to your `$PATH`. Otherwise, the command line will not know about packages installed with Homebrew.

3. Install Python: `brew install python`.
4. Upgrade pip to the latest version: `pip install -U pip`
5. From the root of this repository, install the requirements: `pip install -r requirements.txt`

## Running the app

There are three ways to run the app: locally using Python, via Docker, or using GitHub Codespaces.

### Option 1 - Run Locally with Python

Before running the app for the first time, you'll need to create and seed the local SQLite database:

```bash
python pop_db.py
python dummy_data.py
```

This only needs to be done the first time you run the app.

Next, set your PostHog Host and Project API key as environment variables. You can either rename `.env.example` to `.env` and update the placeholder variables therein (recommended), or run the following:

```bash
export PH_HOST='https://<eu or us>.i.posthog.com'
export PH_PROJECT_KEY='<Project API key>'
```

Finally, run the app:

```bash
python app.py
```

If you open up a browser and head to `http://127.0.0.1:5000/`, you'll see the HogFlix app running. Use `Ctrl + C` in your terminal to stop the app.

Alternatively, after updating `.env`, you can use the Makefile to bootstrap everything in one step:

```bash
make run
```

### Option 2 - Run as a Container with Docker

The container hasn't been pushed to a registry yet, so you'll need to build and run it yourself. Make sure you have [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/) installed.

In the root of the repository, first build the container:

```bash
docker build --no-cache --tag posthog-hogflix-demo .
```

Then run the container in detached mode (background):

```bash
docker run -d -p 5000:5000 -e PH_PROJECT_KEY=<Project API key> -e PH_HOST='https://<eu or us>.i.posthog.com' posthog-hogflix-demo
```

You can then access the app on `localhost:5000`.

### Optional: Enable the built-in Chat (LLM) demo

If you set an OpenAI API key, the app will enable a simple chat interface that is instrumented with PostHog LLM Analytics (Generations and Traces). This lets you explore the LLM Analytics features alongside the seeded demo data.

1. Add the following to your `.env`:

```
OPENAI_API_KEY='<OpenAI API key>'
```

2. Ensure your PostHog environment variables are set as above. The chat will appear in the navbar as “Chat” when `OPENAI_API_KEY` is present.

Notes:
- The app will attempt to use the PostHog-instrumented OpenAI client automatically. If unavailable, it will fall back to the standard OpenAI client while still capturing a `$ai_generation` event per message.
- Models: defaults to `gpt-4o-mini`. You can change this in `app.py`.

### Option 3 - Run in GitHub Codespaces

For a seamless setup, you can run the demo entirely in your browser using **GitHub Codespaces**. This avoids needing to manage Python or Docker on your local machine.

To get started:

1. Go to the repository in GitHub.
2. Click on the **Code** button.
3. Navigate to the **Codespaces** tab and click **Create Codespace on Main**.

This will create a virtual environment in your browser where you can run the app and make changes. It may take a few minutes for the environment to configure, but once done, everything will be set up automatically.

On creation, the devcontainer will:

- Install dependencies
- Create `.env` from `.env.example`

Next steps (one-time):
1) Open `.env` and replace the placeholder values for:
   - `PH_HOST`
   - `PH_PROJECT_KEY`
   - `PH_PERSONAL_API_KEY`
   - `PH_PROJECT_ID`
2) Run the app and bootstrap everything in one step:
```bash
make run
```
This will verify your `.env` is updated, initialize the local DB, seed historical data into PostHog, create demo artifacts in your project, and then start the app.

## Seed Historic Usage Data

To generate valuable insights in your PostHog project, you'll need to add some historic event data. The `seed_demo_data.py` script creates pseudo-random data that mimics real usage of the HogFlix app. You'll need the `500_names_and_emails.csv` in your `scripts` folder (see below on how to generate this), and then run:

```bash
make seed DAYS=30 ITER=100
```

The seeding script will read `PH_PROJECT_KEY` and `PH_HOST` from either your environment or your `.env`. You can still pass `-k` and `-p` flags explicitly if you prefer.

Parameters:
- `-d`: Number of previous days to generate (default 30)
- `-i`: Number of iterations (default 100)

After a few minutes, you'll see newly created events and people in your PostHog project.

## Create Demo Artifacts

Once historic data has been generated, you'll need some PostHog artifacts to view as part of the demo. The `create_posthog_artifacts.py` script adds in:

- Actions looking at pageviews and custom events.
- Cohorts based on behavior and user properties.
- Insights using the above actions.
- A Feature Flag for the action mode feature integrated into the app.

You'll need a **Personal API Key** (available in `/settings/user-api-keys` in the PostHog UI) to run this script:

```bash
make artifacts
```
This script now reads `PH_PERSONAL_API_KEY`, `PH_HOST`, and `PH_PROJECT_ID` from your `.env`.
Optional flags (overrides env when provided):
- `-k`: Personal API key
- `-p`: API base URL (e.g. `https://us.posthog.com/api/projects/<project id>`) 
- `--project_id`: Project ID (used to derive API URL when `-p` not provided)

## Recreate the Seed Data

The `500_names_and_emails.csv` file in the `scripts/` folder contains dummy data for 500 users, which includes group (Family) information. If needed, you can recreate this file by running:

```bash
python scripts/generate_fake_names_and_emails.py
```

## Makefile Shortcuts

Common tasks are wrapped in a `Makefile`:

- `make install`: Install dependencies
- `make env`: Create `.env` from example
- `make check-env`: Verify `.env` placeholders have been replaced
- `make db`: Initialize and seed local DB
- `make run`: Verify env, init DB, seed data, create artifacts, run app
- `make seed`: Seed historical events to PostHog (reads `PH_*` from `.env`; flags optional)
- `make artifacts`: Create PostHog demo artifacts (reads `PH_*` from `.env`; idempotent)
- `make test`: Run tests

Then copy the generated file back to the `scripts/` folder to generate more demo data.

---

Now you're ready to demo the full power of PostHog with **HogFlix Demo 3000**!

posthog-demo-3000

posthog-demo-3000 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

posthog-demo-3000

posthog-demo-3000 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README