Skip to content
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

Fix: Updating documentation for Storybook #264

Merged
merged 4 commits into from
Oct 5, 2022
Merged

Fix: Updating documentation for Storybook #264

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7d458a
Fix: Updating documentation for Storybook
mumanity Oct 4, 2022
177a4b0
Merge branch 'main' into IOTROCI-8828
mumanity Oct 4, 2022
268a704
Merge branch 'main' into IOTROCI-8828
mumanity Oct 5, 2022
cd3bbf4
Merge branch 'main' into IOTROCI-8828
mumanity Oct 5, 2022
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
11 changes: 2 additions & 9 deletions packages/scene-composer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,6 @@ source-map-explorer dist/index.js

## Storybook

First, make a copy of the .env.example as .env, which will be loaded by
storybook to get the credentials to AWS for testing. Update the .env file with
the AWS credentials you get, typically from ada. Below is a one-liner to get
the .env settings.

```bash
ada cred print --account <ACCOUNT_ID> --role <ROLE> | jq -r '"STORYBOOK_ACCESS_KEY_ID=" + .AccessKeyId, "STORYBOOK_SECRET_ACCESS_KEY=" + .SecretAccessKey, "STORYBOOK_SESSION_TOKEN=" + .SessionToken'
```

To make the storybook site run:

```bash
Expand All @@ -42,6 +33,8 @@ npm run build-storybook # run at this package
npm run storybook # run at this package
```

- [Storybook Intro](https://storybook.js.org/docs/react/get-started/introduction)

## Debugging
Scene composer is embedded with a custom logging system based on [debugjs](https://www.npmjs.com/package/debug). With this being a complex component with lots of potential things going on, this system allows you to filter logs based on more specific attributes, and ultimately reduces noise.

Expand Down