GoFish is moving fast and the stable release lags well behind active
development. While the library is pre-1.0, we recommend early adopters install
the nightly build (published whenever main changes):
npm install gofish-graphics@nightly
# or
pnpm add gofish-graphics@nightly
# or
yarn add gofish-graphics@nightlyThe stable release on npm is far behind and will not match the docs, so do not
drop the @nightly tag.
Using Python? pip install --pre gofish-graphics (see the
docs).
import /* your exported functions */ "gofish-graphics";
// Use the library functions hereThis project uses pnpm workspaces for monorepo management.
packages/gofish-graphics/- Main library packageapps/docs/- VitePress documentation site
# Install all dependencies
pnpm install
# Start library development server
pnpm dev
# Build the library
pnpm build
# Start docs development server
pnpm docs:dev
# Build docs
pnpm docs:build
# Preview docs build
pnpm docs:preview
# Run Storybook
pnpm storybook
# Build Storybook
pnpm build-storybookYou can also run commands in specific packages:
# Run commands in the library package
pnpm --filter gofish-graphics <command>
# Run commands in the docs app
pnpm --filter docs <command># Navigate to the library package
cd packages/gofish-graphics
# Update version number
pnpm version patch
# Publish to npm
pnpm publish
# Push new version to github
git pushMIT