Peregrine JS
Peregrine JS serves as a package for common model, utilities, and interfaces that can be shared across Javascript projects.
Setting up a development environment
Dependencies
The Peregrine JS is a package written with TypeScript. There are a couple external dependencies required to run:
Javascript dependencies
Install javascript libraries that Peregrine depends on.
yarn install
Compiling changes
To compile and build the typescript, run:
yarn run build
To build whenver there are changes, run:
yarn run watch
Publishing a new version
Bump the version number
yarn version <version number
# If you just run yarn version, it will prompt you to enter a version number and tell you the current version
yarn version
Push the changes to GitHub
git push origin master
Publish the repo
yarn publish