The template-upload command uploads a component container template to your Supernova workspace. This enables Portal to generate features and prototypes using your actual components, design system, and coding standards.
Before you begin
- Clone and customize the component container template repository
git clone
git@github.com:Supernova-Studio/component-container-template.git
- Install dependencies npm run i and verify the template runs correctly using npm run dev or npm run build
- Docker installed and running locally
- Supernova CLI installed
- Contributor or higher access to the target workspace
Command syntax
supernova template-upload -w [WORKSPACE_ID] -d [DESIGN_SYSTEM_ID]
Options
|
Flag |
Alias |
Description |
Required |
|---|---|---|---|
|
--workspaceId |
-w |
ID of the workspace to upload to. |
Yes |
|
--designSystemId |
-d |
ID of the design system to attach the template to. |
Yes |
|
--force |
-f |
Force upload to the same version, overwriting existing template. |
No |
Example
supernova template-upload -w 332 -d 34142
Obtaining IDs
Get both IDs from your browser URL when viewing your design system:
https://app.supernova.io/[WORKSPACE_ID]-[WORKSPACE_NAME]/ds/[DESIGN_SYSTEM_ID]-[DESIGN_SYSTEM_NAME]/...
After uploading
- In Supernova, go to Workspace Settings, and then open Shared contexts.
- Create new Shared context.
- Select your container and version from the dropdown.
- Publish the Shared context to your workspace.
Projects using this Shared context will now generate features with your custom components.
Troubleshooting
|
Issue |
Resolution |
|---|---|
|
Docker not running |
Start Docker before running the command |
|
Build fails |
Verify npm run build succeeds locally first |
|
Permission denied |
Check you have Contributor access to the workspace |
Need help?
If you're experiencing an issue that is not covered here, contact Supernova support or consult the Supernova Community.