wasp-tweet-dashboard

KO | EN

gitlite — search

#python #typescript #go #machine-learning #deep-learning #linux #docker #nodejs #macos #windows #pytorch #security #ios #open-source

wasp-tweet-dashboard

(★ 13)

No description available.

wasp-tweet-dashboard Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Wasp Team Tweet Dashboard

Tracks the X (Twitter) activity of the Wasp team: impressions, engagements, and
follower growth per person, plus a leaderboard of the best-performing tweets.

A nightly job pulls fresh numbers from the X API into Postgres, the dashboard
reads from Postgres, and — optionally — the same numbers get posted to a
[Buzz](https://github.com/block/buzz) channel over nostr so other apps and
agents can consume them.

Built with [Wasp](https://wasp.sh).

## What it does

- **Roster from config.** `src/config/team.ts` lists the tracked handles. Every
  sync reconciles `TeamMember` rows against it — handles you remove keep their
  history but stop being synced.
- **Daily sync** (`dailySync`, 06:00 UTC). Snapshots each member's follower
  counts, discovers new tweets, and re-reads the metrics of existing ones.
- **Tiered refresh.** Tweet engagement is front-loaded, so fresh tweets are
  re-read daily and settled ones weekly. Anything past the 30-day window is
  never re-read. This is the main cost lever.
- **Dashboard.** Team overview at `/`, per-member detail at `/member/:handle`,
  top tweets, follower charts, and a live X API spend widget.
- **Buzz publishing** (optional). Posts a daily digest to a nostr channel, with
  the full stats as JSON in an event tag for machine consumers.

### A note on cost

X charges roughly **$0.005 per post read**. The sync is built to keep that
small — `since_id` on discovery, tiered refresh, and a 100-tweet-per-member cap
per run — and X dedups billing per post per UTC day, so re-running a sync the
same day is free. Still: pressing **Sync** in the UI spends real money the first
time each day. The dashboard's API usage widget shows current consumption.

## Prerequisites

- **Node.js** (LTS or newer) — install via a version manager like `nvm`
- **Docker** — Wasp uses it to run the local Postgres
- **Wasp CLI**
  ```sh
  npm i -g @wasp.sh/wasp-cli@0.24.0
  ```
- **An X API bearer token** with read access

## Running locally

1. **Configure the environment.**
   ```sh
   cp .env.server.example .env.server
   ```
   Fill in `X_BEARER_TOKEN`. Everything else is optional.

2. **Start the database** (leave this running in its own terminal):
   ```sh
   wasp start db
   ```

3. **Apply migrations:**
   ```sh
   wasp db migrate-dev
   ```

4. **Start the app:**
   ```sh
   wasp start
   ```
   It comes up on [localhost:3000](http://localhost:3000). The first run also
   installs client and server dependencies.

5. **Get some data.** A fresh database is empty, so the dashboard will be too.
   Either wait for the 06:00 UTC job or press **Sync** to run one now — see the
   cost note above.

`wasp compile` type-checks the app without starting it.

## Buzz publishing (optional)

Skip this and the app works fine — the publish step logs a warning and moves on.

You need an invite to a Buzz community (the code is everything after `/invite/`
in an invite link). Then:

```sh
BUZZ_INVITE_CODE=<code> node --env-file=.env.server scripts/buzz-enroll.mjs
```

This mints the bot's nostr keypair, claims the invite, publishes a profile, and
creates the `tweet-stats-from-app` channel. Copy the printed
`BUZZ_NOSTR_SECRET_KEY` and `BUZZ_STATS_CHANNEL_ID` into `.env.server`.

> The secret key is printed **once** and cannot be rotated — a new key is a new
> identity that has to re-enroll. Save it when you see it.

From then on `dailySync` posts the day's digest at the end of its run, and the
`publishTweetStats` job at 06:30 UTC covers the case where the sync failed
before it got there. Posts are deduped per UTC day, so manual syncs won't spam
the channel.

To alert another channel when stats land, fill in the placeholders in
`workflows/stats-landed-alert.yaml` and publish it:

```sh
node --env-file=.env.server scripts/buzz-publish-workflow.mjs workflows/stats-landed-alert.yaml
```

## Deploying

The app is a standard Wasp app — React client, Node server, Postgres. The
quickest path is Wasp's Fly.io integration:

```sh
wasp deploy fly launch <app-name> <region>
```

Then set the server-side secrets:

```sh
wasp deploy fly cmd secrets set X_BEARER_TOKEN=<...> --context=server
```

Only `X_BEARER_TOKEN` is required, plus `BUZZ_NOSTR_SECRET_KEY` and
`BUZZ_STATS_CHANNEL_ID` if you want Buzz publishing. The `BUZZ_INVITE_CODE`,
`BUZZ_ACCEPT_JOIN_POLICY`, `BUZZ_CHANNEL_VISIBILITY`, and `BUZZ_WORKFLOW_ID`
vars are read by the one-off scripts and never by the server, so they don't
belong in production.

> **This app has no authentication.** Deploying it publicly exposes the
> dashboard *and* the sync trigger, which spends X API credits. Put it behind
> access control, or add [Wasp auth](https://wasp.sh/docs/auth/overview), before
> putting it on the open internet.

Wasp docs:

- [Deployment overview](https://wasp.sh/docs/deployment/deployment-methods/overview)
- [Deploying to Fly.io](https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly)
- [Self-hosting](https://wasp.sh/docs/deployment/deployment-methods/self-hosted)
- [Environment variables in production](https://wasp.sh/docs/deployment/env-vars)

## Project layout

```
main.wasp.ts             app spec: routes, jobs, queries, actions
schema.prisma            data model
src/config/team.ts       tracked handles, tracking window, refresh tiers
src/x-api/               X API client
src/sync/                the daily sync job and its manual trigger
src/dashboard/           pages, queries, and metric helpers
src/nostr/               Buzz publishing (relay, stats, job)
scripts/                 one-off Buzz enrollment and workflow publishing
workflows/               Buzz workflow definitions (YAML)
```

## Learn more

- [Wasp docs](https://wasp.sh/docs) — start here
- [Jobs and cron](https://wasp.sh/docs/advanced/jobs) — how `dailySync` is scheduled
- [Wasp extension for VSCode](https://marketplace.visualstudio.com/items?itemName=wasp-lang.wasp)

wasp-tweet-dashboard

wasp-tweet-dashboard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

wasp-tweet-dashboard

wasp-tweet-dashboard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README