README.md

Athlib Javascript

This is the athlib.js library containing code related to athletics. Produces dist/athlib.web.js and optionally dist/athlib.web.js.map.

ES6 library

This repository contains ES6 code and tests.

Detailed overview.

Installation

After cloning this repository, make changes in package.json so they match your ideas.

#optionally rm -rf package-lock.json node_modules
# you might need to add --legacy-peer-deps
npm install --no-optional   #ignore warnings
npm audit

Build and test the library in umd production format

Until we upgrade all the packages, you will need to be on version 16.0 of node which uses older version of SSL: https://stackoverflow.com/questions/69692842/error-message-error0308010cdigital-envelope-routinesunsupported

nvm install 16.0
nvm use 16.0

npm run build  #produces dist/athlib.web.js

Build and test the library in umd debug format

npm run build-debug  #produce dist/athlib.web.js.map as well

Build the library in umd debug format

npm run build-debug-only

Watch and rebuild the library in umd production format

npm run dev    #no testing just watches and rebuilds

Check formatting with eslint

npm run eslint

Check and fix formatting with eslint

npm run eslint-fix

Tests web code

npm run test

Tests web code in node mode

npm run test-node

Watches and tests web code

npm run test:watch

Produce a test coverage report

npm run test:cover

Run a node repl on dist/athlib.web.js

npm run repl

License

Apache-2.0