Merge pull request #130 from eurosky-social/eurosky/fork

deploy

Author: flo-bit

.env.example

@@ -83,3 +83,39 @@ EXPO_PUBLIC_ENABLE_APP_CONFIG=false
 # Disabled for Eurosky; GrowthBook feature-flag fetching is unaffected, so we
 # still pick up upstream's gated features when syncing.
 EXPO_PUBLIC_ENABLE_METRICS=false
+
+#
+#
+# Live sports widget (Discover tab). See src/features/liveSports/README.md.
+#
+#
+
+# Data source: football-data.org (EU-based; free tier covers the World Cup).
+# Get a free token at https://www.football-data.org/client/register
+#
+# Production: leave the token empty and point the API URL at the first-party
+# proxy (services/footballData/), which holds the token server-side. The web
+# deploy already sets this to the mu.social proxy; the proxy's own server-side
+# vars (FOOTBALLDATA_TOKEN etc.) are documented in services/footballData/README.md,
+# not here - they are not EXPO_PUBLIC app vars.
+#   EXPO_PUBLIC_FOOTBALLDATA_API_URL=https://sports.mu.social/v4
+# Local/dev: set the token here to call football-data.org directly (no proxy).
+
+# football-data.org API token. Direct mode only - the token is sent from the
+# client, so leave this empty in production and use the proxy instead.
+EXPO_PUBLIC_FOOTBALLDATA_TOKEN=
+
+# Base URL for football-data.org, or a first-party proxy in front of it. Set
+# this to the proxy host in production. Defaults to https://api.football-data.org/v4.
+EXPO_PUBLIC_FOOTBALLDATA_API_URL=
+
+# Comma-separated football-data.org competition codes. Defaults to "WC" (World
+# Cup). e.g. "WC,CL,PL".
+EXPO_PUBLIC_SPORTS_COMPETITION_CODES=
+
+# Optional module title override. Unset uses a localized default ("Football").
+EXPO_PUBLIC_SPORTS_TITLE=
+
+# Kill switch. The widget auto-hides when no token/proxy is configured; set to
+# 'false' to force it off even when one is.
+EXPO_PUBLIC_ENABLE_SPORTS=

.github/workflows/deploy-web-bunny.yml

@@ -59,6 +59,11 @@ jobs:
           # First-party Bunny proxy for Plausible (see services/plausible/). Needs
           # the scheme: the tracker posts to ${API_HOST}/api/event.
           EXPO_PUBLIC_PLAUSIBLE_API_HOST: https://events.mu.social
+          # First-party Bunny proxy for the live sports widget (see
+          # services/footballData/). Holds the football-data.org token
+          # server-side; the app sends none. Renders null until the worker is
+          # deployed, so it is safe to set ahead of time.
+          EXPO_PUBLIC_FOOTBALLDATA_API_URL: https://sports.mu.social/v4
       - name: Upload to Bunny + purge cache
         run: bash ./scripts/bunny_upload.sh
         env:

.github/workflows/deploy-web-staging-bunny.yml

@@ -77,6 +77,9 @@ jobs:
           # First-party Bunny proxy for Plausible (see services/plausible/). Needs
           # the scheme: the tracker posts to ${API_HOST}/api/event.
           EXPO_PUBLIC_PLAUSIBLE_API_HOST: https://events.mu.social
+          # Shares the prod live-sports proxy (see services/footballData/); the
+          # endpoint is read-only and cached, so staging can reuse it.
+          EXPO_PUBLIC_FOOTBALLDATA_API_URL: https://sports.mu.social/v4
       - name: Upload to Bunny + purge cache
         run: bash ./scripts/bunny_upload.sh
         env:

app.config.js

@@ -1,20 +1,15 @@
 // @ts-check
 const pkg = require('./package.json')
 /**
- * Brand colours, shared with the in-app theme (src/config/brand-theme.ts) and
- * the web pre-boot codegen (scripts/sync-brand-web.mjs). Native chrome renders
- * before any per-user accent preference is known, so it always uses the org's
- * shipped default accent.
- * @type {{accents: Record<string, Record<string, string>>, defaultAccent: string}}
+ * Single brand config (src/config/brand.json; see brand.schema.json). Shared
+ * with the in-app adapters, the web codegen and the Workers. Native chrome
+ * renders before any per-user accent is known, so it uses the shipped default
+ * accent.
+ * @type {{name: string, hosts: string[], socialHandle: string, colors: {accents: Record<string, Record<string, string>>, defaultAccent: string}}}
  */
-const brandColors = require('./src/config/brand-colors.json')
-const BRAND_ACCENT = brandColors.accents[brandColors.defaultAccent]
-/**
- * Brand text identity, shared with brand.ts (BRAND.name / web.hosts) and the
- * web codegen, so the display name / host never drift across runtimes.
- * @type {{name: string, hosts: string[], socialHandle: string}}
- */
-const brandMeta = require('./src/config/brand-meta.json')
+const brand = require('./src/config/brand.json')
+const brandMeta = brand
+const BRAND_ACCENT = brand.colors.accents[brand.colors.defaultAccent]
 
 /**
  * @param {import('@expo/config-types').ExpoConfig} _config
@@ -246,7 +241,7 @@ module.exports = function (_config) {
         // dark browser themes. Standard Expo mechanism, same as upstream, so
         // no custom <link> wiring and minimal merge surface.
         favicon: './assets/favicon.png',
-        // Brand default-accent primary_500 (from src/config/brand-colors.json).
+        // Brand default-accent primary_500 (from src/config/brand.json).
         // Drives the PWA manifest theme_color and the <meta name="theme-color">,
         // i.e. the Chrome Custom Tab toolbar when opening links from the
         // installed PWA on Android. Web-only override; native keeps primaryColor

assets/brand/hero.svg

@@ -1,30 +1,112 @@
 # Rebranding / white-labeling
 
-Brand identity is data + two scripts. The visual + text rebrand happy path:
+Brand identity is **one JSON file + a folder of SVGs + one command**. The visual
++ text rebrand happy path:
 
-## 1. Edit the config (`src/config/`)
+## 1. Edit `src/config/brand.json`
 
-- **`brand-meta.json`** — `name`, `hosts` (your web domains), `socialHandle`.
-- **`brand-colors.json`** — `neutral` ramp, `accents` (the selectable families), `defaultAccent`.
-- **`brand-logo.json`** — `flat` wordmark (required). Set `dimensional: null` if you have no 3D logo; hero surfaces fall back to the flat wordmark in the accent.
-- **`brand.ts`** — `links` (legal/support/download URLs).
+The single source of truth, editor-validated by `brand.schema.json` (your IDE
+flags missing keys, bad hex values, an unknown `defaultAccent`, etc.). Sections:
 
-## 2. Drop in the app icon
+- **identity** — `name`, `hosts` (your web domains; `hosts[0]` is primary),
+  `socialHandle` (X/Twitter @, empty to omit).
+- **`colors`** — `neutral` (the contrast_ ramp), `accents` (the selectable
+  primary_ families), `defaultAccent` (the one this build ships).
+- **`oauth`** — `defaultBaseUrl` (your domain), `clientName`, `scope` /
+  `declaredScope`, `handleResolver`, `signupPdsHost`.
+- **`links`** — legal / support / download URLs (point them at your own pages).
+- **`services`** — atproto endpoints; default to the public Bluesky network,
+  override only what you self-host.
+- **`verification`**, **`ageAssurance`** — trust roots / age backend.
 
-Replace `assets/app-icons/ios_icon_default_next.png` with your 1024×1024 square tile.
+Build-time `EXPO_PUBLIC_*` env vars override a few of these per deployment (see
+`.env.example`); keep those in the env, not the JSON.
+
+## 2. Drop in your logos (`assets/brand/`)
+
+One SVG per role. Only `mark.svg` is **required**; the rest are optional and fall
+back to it, so a single-glyph brand and a symbol+wordmark brand both work:
+
+| file          | role                                            |
+| ------------- | ----------------------------------------------- |
+| `mark.svg`    | the symbol/glyph (required; fallback for all)   |
+| `wordmark.svg`| the styled brand name                           |
+| `lockup.svg`  | symbol + word together                          |
+| `hero.svg`    | large / marketing (a multi-tone "3D" logo lives here) |
+| `icon.svg`    | app-icon-specific art (else the mark on a tile) |
+
+**Theming convention** so one SVG follows light/dark + the accent picker:
+
+- `fill="currentColor"` → the primary tint (driven by the component).
+- `fill="theme:<paletteKey>"` (e.g. `theme:primary_900`) → substituted from the
+  active palette at render. This is how a two-tone `hero.svg` follows the accent;
+  there is no special "dimensional" data shape any more.
+
+Plain colours (hex/rgb) render as-authored (for genuinely multi-colour logos).
 
 ## 3. Run the generators
 
 ```bash
-pnpm brand:gen-favicons   # favicons + safari mask, from the icon tile
-pnpm brand:sync-web       # writes colors/splash/og/title into web/index.html + bskyweb/templates/base.html
-pnpm brand:check-web      # CI guard: non-zero if the above is out of sync
+pnpm brand         # gen-logo + sync-web + favicons - the full visual rebrand
+pnpm brand:check   # CI guard: non-zero if the generated artifacts are stale
 ```
 
-That's the full visual + text rebrand. `BRAND.name` propagates through the UI automatically; the upstream "Bluesky" → name swap lives in `src/config/brandStrings.ts` (add message IDs there if any slip through).
+Under the hood (run individually if you like):
+
+- `pnpm brand:gen-logo` — `assets/brand/*.svg` → `src/config/brand-logo.generated.json`
+  (committed; consumed by `<BrandLogo>`, the splash, and the favicon mask).
+- `pnpm brand:sync-web` — writes the colours / splash / og / title into the
+  pre-boot HTML (`web/index.html`, `bskyweb/templates/base.html`).
+- `pnpm brand:gen-favicons` — favicons + Safari mask from the icon master PNG.
+
+That's the full visual + text rebrand. `BRAND.name` propagates through the UI
+automatically; the upstream "Bluesky" → name swap lives in
+`src/config/brandStrings.ts` (add message IDs there if any slip through).
+
+## App icon + OG image (optional `gen-raster`)
+
+Favicons are generated from the icon master at
+`assets/app-icons/ios_icon_default_next.png` — replace it with your 1024×1024
+square tile, or generate it from SVG:
+
+```bash
+pnpm brand:gen-raster            # from assets/brand/{icon,og}.svg if present
+pnpm brand:gen-raster --compose  # else compose defaults from your mark
+```
+
+`gen-raster` is **optional and not a project dependency**. It auto-detects a
+rasterizer — `@resvg/resvg-js` (install it yourself, never committed) →
+`rsvg-convert` (`brew install librsvg`) → `magick` (ImageMagick) — and skips with
+a message if none is present. It is **non-destructive**: it only writes an output
+when its SVG source exists (`icon.svg` → icon master + favicons; `og.svg` →
+`web/og-image.jpg`), or composes a default under `--compose`. A brand with
+hand-designed raster art ships no source SVGs and is never touched.
+
+## OAuth (per deployment)
+
+You run your own OAuth confidential client (`services/oauth`); the `client_id` is
+your domain. Generate a signing keypair once (do **not** commit the private half):
+
+```bash
+node scripts/gen-oauth-keypair.js   # writes the public JWKS (commit it);
+                                    # prints the private JWK -> Worker secret
+```
+
+Deploy with `scripts/deploy-cloudflare.sh` (see `services/oauth/` and
+`services/web/`). Note: the OAuth assertion host must be a **1-level subdomain**
+(`oauth-brand.example.com`) **or** added as a Worker **Custom Domain** — a
+2-level subdomain (`oauth.brand.example.com`) is not covered by Cloudflare's
+Universal SSL and the TLS handshake will fail.
 
 ## Beyond the basics
 
-- **Services** — edge services live in `services/` (Bunny scripts). Network read APIs default to Bluesky's (until eurosky appview is available). You **must** run your own **OAuth** (`services/oauth` — the client_id is your domain); optionally your own OG / analytics / geolocation / age. Point the app at them via `EXPO_PUBLIC_*` env vars (see `.env.example`). Bluesky's GrowthBook flags + product metrics are toggled by the `EXPO_PUBLIC_ENABLE_*` flags.
-- **Native build** (separate pass) — bundle IDs, app name, scheme, app groups, associated domains, EAS / App Store / Sentry / Firebase IDs: `app.config.js`, `eas.json`, `ios/`, `android/`.
-- **Content** (optional, still eurosky-specific) — onboarding packs, suggested follows, default feeds, news sources, verifier DIDs: `src/screens/Onboarding/`, `src/features/newsFeed/sources.ts`, `src/lib/constants.ts`.
+- **Services** — edge services live in `services/`. Read APIs default to
+  Bluesky's; override per build via `EXPO_PUBLIC_*` (see `.env.example`).
+  GrowthBook flags + product metrics toggle via `EXPO_PUBLIC_ENABLE_*`.
+- **Native build** (separate pass) — bundle IDs, app name, scheme, app groups,
+  associated domains, EAS / App Store / Sentry / Firebase IDs live in
+  `app.config.js`, `eas.json`, `ios/`, `android/`.
+- **Content** (optional) — onboarding packs, suggested follows, default feeds,
+  news sources, verifier DIDs: `src/screens/Onboarding/`,
+  `src/features/newsFeed/sources.ts`, `src/lib/constants.ts`.
+```

assets/brand/mark.svg

@@ -37,9 +37,10 @@ export default defineConfig(
       'bskyembed/**',
       'bskyogcard/**',
       // Eurosky fork: first-party edge services (OAuth client-assertion,
-      // Plausible proxy, IP geolocation, per-route Open Graph injector) live
-      // under services/. They are Bunny/Cloudflare Edge Scripts (Deno runtime +
-      // URL imports), not app code, so the whole tree is excluded.
+      // Plausible proxy, IP geolocation, per-route Open Graph injector,
+      // football-data.org proxy for the live sports widget) live under
+      // services/. They are Bunny/Cloudflare Edge Scripts (Deno runtime + URL
+      // imports), not app code, so the whole tree is excluded.
       'services/**',
       'src/locale/locales/_build/**',
       'src/locale/locales/**/*.js',

docs/rebranding.md

@@ -64,9 +64,14 @@
     "lint-native": "swiftlint ./modules && ktlint ./modules",
     "lint-native:fix": "swiftlint --fix ./modules && ktlint --format ./modules",
     "typecheck": "tsgo --project ./tsconfig.check.json",
+    "brand:gen-logo": "node scripts/gen-logo.mjs",
+    "brand:check-logo": "node scripts/gen-logo.mjs --check",
     "brand:sync-web": "node scripts/sync-brand-web.mjs",
     "brand:check-web": "node scripts/sync-brand-web.mjs --check",
     "brand:gen-favicons": "node scripts/gen-brand-favicons.mjs",
+    "brand:gen-raster": "node scripts/gen-raster.mjs",
+    "brand": "node scripts/gen-logo.mjs && node scripts/sync-brand-web.mjs && node scripts/gen-brand-favicons.mjs",
+    "brand:check": "node scripts/gen-logo.mjs --check && node scripts/sync-brand-web.mjs --check",
     "e2e:mock-server": "cd dev-env && pnpm start",
     "e2e:build": "EXPO_PUBLIC_ENV=e2e NODE_ENV=test RN_SRC_EXT=e2e.ts,e2e.tsx expo run:ios",
     "e2e:build-android": "EXPO_PUBLIC_ENV=e2e NODE_ENV=test RN_SRC_EXT=e2e.ts,e2e.tsx expo run:android",

eslint.config.mjs

@@ -8,7 +8,7 @@
 # (matching the Bunny edge feature set). It is distinct from scripts/bunny_build.sh,
 # the pre-existing Cloudflare *Pages* build (static only, no OG/geolocation).
 #
-# Brand name + host come from src/config/brand-meta.json (the same source the
+# Brand name + host come from src/config/brand.json (the same source the
 # app and Workers read). This script only wires the deployment-specific bits:
 # build env, Worker names, and the OAuth assertion URL.
 #
@@ -45,8 +45,8 @@ done
 
 # Brand identity from the single source. Slugify the display name for the CF
 # Worker resource names (lowercase, alphanumeric + hyphens).
-BRAND_SLUG="$(node -p 'require("./src/config/brand-meta.json").name.toLowerCase().replace(/[^a-z0-9]+/g,"-").replace(/(^-|-$)/g,"")')"
-PRIMARY_HOST="$(node -p 'require("./src/config/brand-meta.json").hosts[0]')"
+BRAND_SLUG="$(node -p 'require("./src/config/brand.json").name.toLowerCase().replace(/[^a-z0-9]+/g,"-").replace(/(^-|-$)/g,"")')"
+PRIMARY_HOST="$(node -p 'require("./src/config/brand.json").hosts[0]')"
 SITE_URL="${SITE_URL:-https://${PRIMARY_HOST}}"
 WEB_WORKER="${BRAND_SLUG}-web"
 OAUTH_WORKER="${BRAND_SLUG}-oauth-assertion"