@virtual-teacher/yellowstone

Yellowstone

Installation:

npm install @virtual-teacher/yellowstone

Local setup:

1. build docker image

docker-compose build

2. install dependencies:

docker-compose run gui npm install

3. start storybook:

docker-compose up

4. visit http://localhost:6006

Add new icon

1. Add a .svg file to src/components/Icon/assets/. Make sure that the svg is in a rectangle (viewBox).
2. Run npm run generate-svg - generates React components from .svg files in src/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:

1. build and pack yellowstone package:

$ npm run build && npm pack

2. install created archive in other project e.g. students:

$ npm install ../yellowstone/virtual-teacher-yellowstone-1.4.10.tgz

3. restart project server:

$ npm start