datavisyn / visyn_core

BSD 3-Clause "New" or "Revised" License
1 stars 1 forks source link

visyn_core

NPM version build

Features

Installation

git clone -b develop https://github.com/datavisyn/visyn_core.git  # or any other branch you want to develop in
cd visyn_core

# Frontend
yarn install

# Backend
python3 -m venv .venv  # create a new virtual environment
source .venv/bin/activate  # active it
make develop  # install all dependencies

Local development

# Frontend
yarn start

# Backend
python visyn_core

Testing

# Frontend
yarn run test

# Backend
make test

Playwright and Chromatic

To run all tests and create snapshots, execute Playwright first. With this command all snapshots are already taken and captured in an archive. Make sure to commit all your changes before taking any snapshots. Before executing this command, make sure backend and frontend are running smoothly.

yarn pw:run

To upload these snapshots to Chromatic’s cloud and review them, execute:

yarn chromatic --playwright -t=<TOKEN>

Chromatic creates for every test a story in storybook, although these are not responsive. When clicking on the link in the terminal, all changes can be reviewed and storybook can be opened.

Playwright documentation: https://playwright.dev/docs/intro

Chromatic with Playwright: https://www.chromatic.com/docs/playwright/

Building

yarn run build