Skip to content
DigitalcheffePublic

About

Self-hosted dashboard that tracks how a launch event creates ripples across Reddit, GitHub, GA4, and Bing

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Rippl3FX

Self-hosted dashboard that tracks how a launch event creates ripples across platforms. One GitHub release, one blog publish, one product launch — Rippl3FX measures the spread across GitHub, GA4, and Bing using three universal lanes: Reach, Interest, Engagement.

Mark events (launches, posts, releases) and watch the ripple spread across your connected platforms.

Built with Claude Code — the AI-powered coding agent by Anthropic. Architecture, implementation, and documentation were developed collaboratively between a human product owner and Claude Code.

Rippl3FX Dashboard

Features

  • Three-lane model — Reach, Interest, Engagement across all platforms
  • Events — mark launches and releases, see vertical markers on charts
  • Platform polling — automated data collection with configurable intervals
  • Hourly, daily, weekly, monthly time ranges with velocity tracking
  • Docker deployment — single image, SQLite database, zero external dependencies
  • Zero config — secrets auto-generated on first run, no .env required

Platform Setup

See docs/account-setup.md for step-by-step instructions to connect:

  • GitHub — Personal Access Token (classic) with repo scope
  • GA4 — Google Cloud service account with Analytics Viewer role
  • Bing — Webmaster Tools API key

Configuration

Week Start Day

By default, weekly metrics use Monday as the first day of the week. Change this in Settings → Profile → Week Starts On to any day (Sunday through Saturday). All weekly rollups, chart boundaries, and date labels will align to your preference.

First Run

Rippl3FX is a single-user application — there are no teams, invitations, or multi-user accounts. On first launch, you'll be prompted to create your username and password. This is the only account and cannot be changed to multi-user later. Optional TOTP two-factor authentication can be enabled in Settings after setup.

Quick Start — Docker

The database, encryption keys, and JWT secrets are automatically generated and stored in the volume. Everything persists across restarts — no .env file needed.

Create a docker-compose.yml:

services:
  rippl3fx:
    image: ghcr.io/digitalcheffe/rippl3fx:latest
    ports:
      - "3000:3000"
    volumes:
      - rippl3fx-data:/data
    environment:
      - TZ=America/New_York    # Optional: set your timezone

volumes:
  rippl3fx-data:
docker compose up -d

That's it. Open http://localhost:3000 and create your account on first run.

Environment Variables

All environment variables are optional. The app works out of the box with no configuration.

Variable Default Description
ENCRYPTION_KEY Auto-generated Override the encryption key for platform credentials
JWT_SECRET Auto-generated Override the JWT signing secret
PORT 3000 Server port
TZ UTC Timezone for rollups and date boundaries (e.g. America/New_York)
CORS_ORIGIN Required Allowed origin for API requests (e.g. https://rippl3fx.example.com or http://192.168.1.50:3000)

If ENCRYPTION_KEY or JWT_SECRET are not set, the app generates random secrets on first startup and stores them in /data/config.json. Setting env vars overrides the stored values.

Data Persistence

All data lives in /data inside the container:

File Purpose
/data/rippl3fx.db SQLite database (accounts, metrics, events)
/data/config.json Auto-generated encryption key and JWT secret

The docker-compose.yml above mounts a named volume to /data. To use a local directory instead:

volumes:
  - ./my-data:/data

Development

cd backend && npm install && npm run dev    # Backend on :3000
cd frontend && npm install && npm run dev   # Frontend on :5173

When running outside Docker, data is stored in backend/data/ by default. Set DATA_DIR to change the location.

About

Self-hosted dashboard that tracks how a launch event creates ripples across Reddit, GitHub, GA4, and Bing

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages