hog-lite

HogLite

The best way to view your PostHog analytics on the go!

Introduction

HogLite is an open-source PostHog client for mobile devices. The app allows users to view their PostHog dashboards, events, and more. This repository contains the code for the HogLite app. The app does not have a custom backend, but rather, directly communicates with PostHog's API.

Documentation Sections

• HogLite
  • The best way to view your PostHog analytics on the go!
  • Introduction
  • Documentation Sections
  • Setting up the environment
  • Running the application
  • Architecture
    • Managing Server State
    • Managing Client State
  • Debugging
  • Creating Builds/Releases
    • App Store Update
    • OTA Update

Setting up the environment

1. Install the required packages by running the following command:

yarn install

Running the application

Run the following command to start the application in development mode:

yarn dev

Architecture

Managing Server State

All async state should be handled via Tanstack Query. Every API query and mutation has an associated hook in the hooks/api folder. The hooks should be used in the components to fetch and mutate data. The hooks are responsible for managing the state and fetching the data from PostHog's backend.

Relevant optimistic updates or cache updates (when mutating data) should be handled in the hooks.

Every component using a query should validate isLoading, isError, and data states to handle the UI accordingly.

Managing Client State

All client state is stored in two unique Zustand stores: auth-store (useAuthStore) and client-store (useClientStore). The auth-store is responsible for managing the user's authentication state, while the client-store is responsible for managing the client's preferences, settings, and state.

Both stores persist their data and rehydrate it on app startup. All persisted client state should be stored in one of these stores. Do NOT directly access a store's state in a component. Instead, set up a selector to prevent inefficient re-renders. See example below:

// DON'T DO THIS
const clientStore = useClientStore();

return Your theme is: {clientStore.theme};

// INSTEAD, DO THIS
const theme = useClientStore((state) => state.theme);

return Your theme is: {theme};

Debugging

To help with debugging, we've added debugging tools to the application when running in development mode.

• Network Requests: To view network requests, press three fingers on the screen to open the network inspector.
• Client Store State: To view the current state in async storage, press three fingers on the screen, and click 'Client Store'

Creating Builds/Releases

HogLite has two different update methods. The first is a traditional app store update, and the second is an OTA update. The app store update is used for major updates (typically with new native code), while the OTA update is used for minor updates (with only JavaScript changes). See below for instructions on how to create each type of update.

App Store Update

1. Update the app version: Update the app version in the app.json file. Increment the version field by one. For example, if the current version is 1.0.0, the new version should be 1.0.1.
2. Build the app: Run the following command to build the app:

eas build --platform ios --profile production

1. Submit the app: Submit the app to the app store using the eas submit command. For example, to submit the iOS app, run the following command:

eas submit --platform ios

OTA Update

When running OTA updates, staging/preview updates MUST be ran before production updates. This is to ensure that the update is working as expected before being released to all users. This will also automatically update the 'update version' for the build. The production script will NOT update the 'update version' for the build.

1. Run the following command to deploy the OTA update to the staging environment. This will automatically increment the 'update version' for the build and set the build date to the current date:

yarn update:staging

1. Test the update on the staging environment to ensure that it works as expected.
2. Run the following command to deploy the OTA update to the production environment:

yarn update:production

1. Test the update on the production environment to ensure that it works as expected.