Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 1.29 KB

README.md

File metadata and controls

60 lines (41 loc) · 1.29 KB

Library Core

NPM Version Package Size

Core tools for use with other Library API packages.


Description

These can also be used to build your own app based on this API.

This package is brought to you by Library API.

Installing

Please note that core tools are built to run on a Node environment as it requires a filesystem to store downloaded files.

You can install with your preferred package manager:

# NPM
npm install @library-api/core

# Yarn
yarn add @library-api/core

Documentation

View the documentation here

Development

Run the following commands to get started. If you are running from the root directory you can add media to run these (for example yarn core build instead of just yarn build):

# Build (outputs to /dist)
yarn build

# Lint files
yarn lint

# Run test suite
yarn test

# Run Type Checking Service
yarn tsc