tamarac-utilities

Tamarac Utlities is Tamarac Inc's JavaScript helper package.

Docusaurus (Documentation)

Docusaurus is a documentation library which powers this site's documents. The documents are based in .md (MarkDown) and can be formatted as such.

The most stable version of the documents are served with the pre-release available by prefixing the docs/next/ after the base URL OR by visiting the versions page and clicking on documentation link.

Run locally:

  yarn start || yarn docs

Build Static Site:

  yarn buildDocs

Testing

Testing components is key to the success of this library. Test coverage should be no less than 95% and aim for 100% at all times.

Run tests in watch mode:

  yarn test:watch

Get coverage report for library:

  yarn test:coverage

A test result file will be generated dynamically on each test run .jest-test-results.json