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_IDSetPLANEWARD_APP_SECRETSetPLANEWARD_WEBHOOK_SECRETSetPLANEWARD_BASE_URLUnsetDATABASE_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.* webhooksCOMMUNITY_MESSAGES_WRITE“Announce as the app” on the member view
Steps
- Start Postgres with
docker compose up -dand runpnpm db:migrate. - Start a tunnel to port 3008, put its hostname in
ALLOWED_DEV_ORIGINSin.env, restartpnpm dev, and open this page through the tunnel. - Create the app in Planeward under Settings › Apps › Developer with the URLs and scopes above.
- Copy the app id, app secret and webhook secret into
.env, then restartpnpm dev. - Install the app in your workspace. The
app.installedwebhook stores the installation. - Add the app to your community as a channel and open it. Staff can open the dashboard under Community › Apps.