What an app profile holds
The settings Showreel Studio keeps for each app, its addresses per environment, and which one a project records from.
An app profile tells Showreel Studio how to open and work one app. You normally make it with Connect your app, but it helps to know what is in it, especially if your app has more than one address.
Where it lives
Each profile is a file in your project: apps/<name>.json. The project's own settings file, showreel.json, says which app the project films ("app") and which of its addresses to use ("env").
What is in a profile
| Part | What it does |
|---|---|
| Name | The app's name, for people. |
Addresses (urls) | One address per environment, such as local, qa or production. |
| Ready check | Something the app draws once it has loaded. A film waits for it before doing anything. |
| Settle time | How long to wait after the ready check while the page stops moving. |
| Navigation | How to reach a menu item by its name. |
| Busy marker | A spinner or loading state to wait out. |
| Starting state | Anything the app should find in the browser's storage when it opens. |
| Sign-in | Whether it opens signed out, or records with a profile you signed in to once. |
| Device | Desktop, or filmed as a phone or tablet with touch. |
| Mask | Personal data to replace, blur or hide on every film of this app. |
| Traps | Plain notes about anything awkward, read by whoever writes the code that operates the app. |
Environments
An environment is simply a named address for the same app. When you connect an app, Showreel Studio names the environment from the address: local for your Mac or a file, qa for addresses with words like staging, qa, dev or test in them, and production for the rest.
A project records from the environment named in showreel.json. When you save a profile with Save and use it on the Apps page, the project switches to that app and that environment.
To give one app several addresses, add them under urls in its profile file:
"urls": {
"local": "http://localhost:3000",
"qa": "https://qa.example.com"
}Then set "env": "qa" in showreel.json to record from the QA address.
One film, a different address
A single film can differ from the project:
- In the app, open the film's Film panel and fill in App address, if not the profile's.
- In the storyboard file, set
app,envorurlfor that film only.
In the terminal, most recording commands also take --url for a one-off address:
showreel record compose --url https://preview.example.com