Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.24 KB

DEVELOPMENT.md

File metadata and controls

51 lines (31 loc) · 1.24 KB

Development

Getting Started

This project houses the falcon-vis library and examples.

To cut down on node garbage, we are using yarn workspaces to install and share packages across those projects. In the examples/ directory alone there are a few separate Svelte projects.

To install all packages in the workspace

yarn

Warning If you're using npm to do this, use npm install --legacy-peer-deps

To run the development server

yarn dev

A new browser tab will open that uses thefalcon-vis library.

Changes made in the falcon-vis package or svelte examples will be updated on save.

Build

Check the respective projects package.json to get individual instructions how to build examples or the main library.

Publish to NPM

yarn publish-falcon-vis

will publish to npm.

Deploy Examples

yarn deploy-examples

will deploy all the live examples listed in the deploy.sh.

Standards

  1. We use the Conventional Commits standards for commit messages.
  2. We format code with Prettier as defined by the falcon2/.prettierrc