Welcome! Vanellus is the Kiebitzt Typescript library that provides all necessary functionality for building web applications based on the Kiebitz API and data models.
This is still a work in progress.
Requirements
To run this library in the browser you'll need the buffer
package, which implement the Buffer
object from Node.js.
Building
To build the distribution files, simply run
make build
Formatting
To format files, simply run
make prettier
Development
To continuously build files and watch for changes, simply run
make watch
Testing
To run the unit & integration tests
make test
These tests require a running Kiebitz test instance with appointments and storage services, as well as a readable 002_admin.json
key file in the Kiebitz settings directory. The default directory is ../services/settings/test
. You can change the directory and service ports by setting the KIEBITZ_SETTINGS
, KIEBITZ_APPOINTMENTS_PORT
and KIEBITZ_STORAGE_PORT
environment variables.