Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.11 KB

File metadata and controls

31 lines (21 loc) · 1.11 KB

CovidJS

This is an NPM package designed to make it easier to integrate data from various COVID-related API's into your project so you can easily access up-to-date vaccine availability data.

The purpose of this library is to make it easier for developers to access multiple COVID-related API's and allow the maintainers of those API's to have some control over client implementations. This provides the API developers with the ability to help move projects over to a new versions of their API should they need to make a breaking change. This also helps developers more easily access data from multiple API's and update their implementations just by updating a dependency.

Documentation

documentation can beseen in the docs folder or at https://vacfind.github.io/CovidJS/

Install

TBD - not yet published as an NPM package. File an issue if this is incorrect

Usage

Importing

<script src="./path/to/covidjs.bundle.js" ></script>

<script>
	covidjs.helloWorld()
</script>

Development

To build the CovidJS libary for development purpooses, use the following commands:

yarn install
yarn build