squiggle/packages/components/README.md

36 lines
813 B
Markdown
Raw Normal View History

# Squiggle Components
2022-03-23 14:01:51 +00:00
This package contains all the components for squiggle. These can be used either as a library or hosted as a [storybook](https://storybook.js.org/).
2022-02-27 04:41:30 +00:00
# Build for development
2022-03-23 14:01:51 +00:00
You need to _prepare_ by building and bundling `squiggle-lang`
``` sh
cd ../squiggle-language
yarn
yarn build
yarn bundle
```
If you've otherwise done this recently you can skip those.
2022-02-27 04:41:30 +00:00
2022-03-23 14:01:51 +00:00
Then, you can install dependencies
``` sh
cd packages/components
yarn
```
Run a development server
``` sh
yarn start
```
And build artefacts for production,
2022-03-23 14:01:51 +00:00
``` sh
yarn bundle # builds components library
yarn build # builds storybook app
```
## TODO: double check if `tsc && webpack` is redundantly equivalent to `webpack`. (Edit job step name in `ci.yaml` if you edit the script).
## TODO: test coverage for react code