Planeward Community App

Setup

This app runs inside a Planeward community as an iframe. Register the URLs below, install the app, then add it to your community as a channel.

Environment
Read from the repo root .env. Values are never shown. 1 missing: copy .env.example to .env and fill it in.
  • PLANEWARD_APP_IDSet
  • PLANEWARD_APP_SECRETSet
  • PLANEWARD_WEBHOOK_SECRETSet
  • PLANEWARD_BASE_URLUnset
  • DATABASE_URLSet
URLs to register
In Planeward: Settings › Apps › Developer. Built from this request’s host; use your public HTTPS domain in production.
Scopes to request
  • COMMUNITY_MEMBERS_READDashboard member list and community.membership.* webhooks
  • COMMUNITY_MESSAGES_WRITE“Announce as the app” on the member view
Steps
  1. Start Postgres with docker compose up -d and run pnpm db:migrate.
  2. Start a tunnel to port 3008, put its hostname in ALLOWED_DEV_ORIGINS in .env, restart pnpm dev, and open this page through the tunnel.
  3. Create the app in Planeward under Settings › Apps › Developer with the URLs and scopes above.
  4. Copy the app id, app secret and webhook secret into .env, then restart pnpm dev.
  5. Install the app in your workspace. The app.installed webhook stores the installation.
  6. Add the app to your community as a channel and open it. Staff can open the dashboard under Community › Apps.