Skip to content

Update documentation and env-example #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LinaBell merged 1 commit into from
Feb 11, 2026
Merged

Update documentation and env-example #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions .env-example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

Expand Down
Loading