Skip to content

Commit eb503e7

Browse files
committed
Merge branch 'main' of github.com:seamapi/react into fake-thermostats
2 parents e3c86dd + d8e6045 commit eb503e7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+3049
-1321
lines changed

README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export function App() {
7878
<seam-device-table publishable-key="your_publishable_key"></seam-device-table>
7979
<script
8080
type="module"
81-
src="https://react.seam.co/v/1.38.0/dist/elements.js"
81+
src="https://react.seam.co/v/1.44.0/dist/elements.js"
8282
></script>
8383
</body>
8484
```
@@ -303,40 +303,55 @@ $ npm install
303303

304304
Develop components with [Storybook].
305305

306-
Run Storybook in development mode with
306+
Run the full storybook in development mode with
307307

308308
```
309309
$ npm start
310310
```
311311

312-
The Storybook is deployed in docs mode.
313-
Develop the Storybook in docs mode with
312+
The deployed storybook runs in docs mode which does not contain the full storybook.
313+
Develop the storybook in docs mode with
314314

315315
```
316316
$ npm run docs:start
317317
```
318318

319319
[Storybook]: https://storybook.js.org/
320320

321-
### Fake Seam Connect
321+
#### Chromatic
322322

323-
This project uses a [fake version of Seam Connect](https://github.com/seamapi/fake-seam-connect)
324-
to have deterministic responses for rendering views and running tests.
323+
[Chromatic] automates visual and interaction tests for Storybook.
325324

326-
Edit the seed data for the fake or find relevant ids for testing components here:
325+
On each commit, the full storybook is published to Chromatic for review.
326+
On pull requests, Chromatic will run UI regressions tests on each commit.
327+
Chromatic reports results as status checks that link directly to the storybook.
327328

328-
- [Storybook fake seed](./.storybook/seed-fake.js).
329-
- [Jest test fake seed](./test/jest/global-setup.cjs).
329+
If changes are detected, follow the link in the status checks to approve the changes.
330+
_Contributors must be granted access to approve changes on Chromatic;
331+
request access from another maintainer of this project._
332+
333+
[Chromatic]: https://www.chromatic.com/
330334

331335
### Previews
332336

333-
Every pull request deploys the Storybook with the examples
337+
Every pull request deploys the storybook in docs mode with the examples
334338
in a [Vercel Preview Deployment]
335339
where you may [comment directly on the preview][Vercel Comments].
340+
This is the same storybook published on [react.seam.co](https://react.seam.co).
336341

337342
[Vercel Preview Deployment]: https://vercel.com/docs/concepts/deployments/preview-deployments
338343
[Vercel Comments]: https://vercel.com/docs/concepts/deployments/comments
339344

345+
### Fake Seam Connect
346+
347+
This project uses a [fake version of Seam Connect](https://github.com/seamapi/fake-seam-connect)
348+
to have deterministic responses for rendering views and running tests.
349+
350+
Edit the seed data for the fake or find relevant ids for testing components here:
351+
352+
- [Storybook fake seed](./.storybook/seed-fake.js).
353+
- [Jest test fake seed](./test/jest/global-setup.cjs).
354+
340355
### Tests
341356

342357
Write tests with [Jest].

0 commit comments

Comments
 (0)