@chialab/exercises

Models and utilities for web based exercises.

Usage no npm install needed!

<script type="module">
  import chialabExercises from 'https://cdn.skypack.dev/@chialab/exercises';
</script>

README

Exercises • Models and utilities for web based exercises.

NPM

Get the library

Usage via unpkg.com as ES6 module:

import { ... } from 'https://unpkg.com/@chialab/exercises?module';

Install via NPM:

$ npm i @chialab/exercises
$ yarn add @chialab/exercises

import { ... } from '@chialab/exercises';

Development

Build status codecov

Build the project

Install the dependencies and run the build script:

$ yarn install
$ yarn build

This will generate the ESM bundles in the dist folder, as well as the declaration files.

Test the project

Run the test script:

$ yarn test

Release

The release script uses Semantic Release to update package version, create a Github release and publish to the NPM registry.

An environment variable named GH_TOKEN with a generated Github Access Token needs to be defined in a local .env file.

$ echo 'export GH_TOKEN="abcxyz"' > .env

Now you are ready to run the release command:

$ yarn release

License

Exercises is released under the MIT license.