Skip to content

Package.json Scripts Reference

yacoubii edited this page Dec 20, 2024 · 1 revision
Task Description Usage
postinstall Automatically launched after performing yarn install. Installs Palindrome.js services (TSDB Service and Local Monitoring Server). -
predev Automatically launched before performing yarn dev. Ensures the TSDB Service and Local Monitoring Server are running, which are required for Palindrome.js to function properly. -
prestorybook Automatically launched before performing yarn storybook. Ensures the TSDB Service and Local Monitoring Server are running, which are required for Palindrome.js to function properly. -
dev Launches Palindrome.js in the dev environment. yarn dev
build:local Builds the dev environment with all use cases. yarn build:local
build Builds the dev environment for GitHub Pages, excluding use cases requiring a backend. The build result is in the dist folder. yarn build
build:dev Builds the Palindrome.js dev environment as a library. yarn build:dev
build:basic Builds the Palindrome.js basic environment (without the sidebar) as a library. yarn build:basic
storybook Launches Palindrome.js in the storybook environment. yarn storybook
build-storybook Builds the storybook environment. The build result is in the storybook-static folder. yarn build-storybook
cypress:run Runs Cypress headless tests. yarn cypress:run
cypress:open Opens the Cypress GUI. yarn cypress:open
storybook-deploy Deploys the storybook environment to GitHub Pages. yarn storybook-deploy
dev-deploy Deploys the dev environment to GitHub Pages. yarn dev-deploy
benchmark "classic" Runs the benchmark script. yarn benchmark "classic"
benchmark "evaluation" Runs the evaluation based on the benchmark script. yarn benchmark "evaluation"
benchmark <"evaluation" | "classic"> "headless" Runs the benchmark or the evaluation script in headless mode. yarn benchmark <"evaluation" | "classic"> "headless"
benchmark <"evaluation" | "classic"> "visual" Runs the benchmark or the evaluation script in visual mode. yarn benchmark <"evaluation" | "classic"> "visual"
Clone this wiki locally