From 38be6968daf9577e406b868f96b42674f08948e0 Mon Sep 17 00:00:00 2001 From: Lina Date: Tue, 10 Feb 2026 19:03:48 -0800 Subject: [PATCH] Update .env-example and README --- .env-example | 9 +++------ README.md | 23 ++++++++++++++--------- 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/.env-example b/.env-example index 8e42014..d6327a0 100644 --- a/.env-example +++ b/.env-example @@ -1,7 +1,4 @@ -API_URL=http://localhost:3001 -NODE_ENV="development" -PORT=3001 - INSTANCE_DOMAIN=api.topia.io -INTERACTIVE_KEY==****\*\***** -INTERACTIVE_SECRET=****\*\***** +INTERACTIVE_KEY=your_interactive_key +INTERACTIVE_SECRET=your_interactive_secret +NODE_ENV="development" diff --git a/README.md b/README.md index 7d30d78..4db2851 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,18 @@ Scene Swapper is an on-canvas application allowing users to swap scenes by click - Key Asset: the data object attached to the dropped key asset stores the default and currently displayed scene. +## Environment Variables + +Create a `.env` file in the root directory. See `.env-example` for a template. + +| Variable | Description | Required | +| ---------------------- | ---------------------------------------------------------------------------------- | -------- | +| `NODE_ENV` | Node environment | No | +| `SKIP_PREFLIGHT_CHECK` | Skip CRA preflight check | No | +| `INSTANCE_DOMAIN` | Topia API domain (`api.topia.io` for production, `api-stage.topia.io` for staging) | Yes | +| `INTERACTIVE_KEY` | Topia interactive app key | Yes | +| `INTERACTIVE_SECRET` | Topia interactive app secret | Yes | + ## Developers ### Built With @@ -25,16 +37,9 @@ Scene Swapper is an on-canvas application allowing users to swap scenes by click ### Add your .env environmental variables -```json -API_KEY=xxxxxxxxxxxxx -INSTANCE_DOMAIN=api.topia.io -INSTANCE_PROTOCOL=https -INTERACTIVE_KEY=xxxxxxxxxxxxx -INTERACTIVE_SECRET=xxxxxxxxxxxxxx -SCENE_IDS=xxxxxxxxxxxxxx,xxxxxxxxxxxxxx,xxxxxxxxxxxxxx -``` +See [Environment Variables](#environment-variables) above. -### Where to find API_KEY, INTERACTIVE_KEY and INTERACTIVE_SECRET +### Where to find INTERACTIVE_KEY and INTERACTIVE_SECRET [Topia Dev Account Dashboard](https://dev.topia.io/t/dashboard/integrations)