@virtual-teacher/yellowstone
v2.3.4
Published
Virtual Teacher UI components repo
Downloads
6
Readme
Yellowstone
Installation:
npm install @virtual-teacher/yellowstone
Local setup:
- build docker image
docker-compose build
- install dependencies:
docker-compose run gui npm install
- start storybook:
docker-compose up
- visit http://localhost:6006
Add new icon
- Add a .svg file to
src/components/Icon/assets/
. Make sure that the svg is in a rectangle (viewBox
). - Run
npm run generate-svg
- generates React components from .svg files insrc/components/Icon/assets
.
Publishing:
In order to publish new version, bump package version in package.json file, and create new release on GitHub. It will trigger workflow that will upload new version to GitHub NPM registry.
Test your local changes inside other project:
- build and pack yellowstone package:
$ npm run build && npm pack
- install created archive in other project e.g. students:
$ npm install ../yellowstone/virtual-teacher-yellowstone-1.4.10.tgz
- restart project server:
$ npm start