Wizard Server

Wizard Server is the core application of the Data Stewardship Wizard: knowledge models, projects, document generation, user and tenant management and real-time collaboration.

This repository is a read-only distribution: the sources are generated from the development repository and pushed here, so pull requests cannot be merged directly. Discuss changes in an issue first, see CONTRIBUTING.

Repository layout

app/wizard-server   entry point
src/               Shared, WizardLib, RegistryLib, Wizard
test/              hspec suites: shared wizard-lib wizard
config/            configuration, committed templates as *.example
scripts/           build info, config expansion, strict build

Requirements

• Stack (GHC 9.10.3, snapshot lts-24.37) and hpack
• PostgreSQL 15 and MinIO/S3
• engine-jinja libraries in lib/ (document templating)
• Optional: fourmolu, hlint, cspell

Build and run

./scripts/expand-example-files.sh   # creates the gitignored configs from *.example
make build
make run

The document templating needs the engine-jinja libraries in lib/. Download them from the releases or compile them yourself; the Makefile exports PYTHONPATH, LD_LIBRARY_PATH and DYLD_LIBRARY_PATH to that folder.

Tests and code style

make test                                    # all suites (needs a running database)
make test-wizard
make check                                   # hlint + fourmolu + cspell
make format

License

This project is licensed under the Apache License v2.0 - see the LICENSE file.