🚧 This website is still under construction. Please stay tuned. 🚧
Developers
ETL Pipeline
Contributing

Contributing

The easiest way to start developing if you are using nix is to use devenv via the provided flake.nix.

Using Nix

# If you have Nix installed
nix develop --impure
# This will drop you into a shell with all the dependencies installed
# And it will also require the experimental flags:
# Disclaimer nix-commands and flakes are experimental features so you will need to add these flags to the command to be able to run them.
--extra-experimental-features 'nix-command flakes'
# You will also been prompted to accept/decline some extra configurations. You can accept them without receiving a prompt using this or manually decide without adding it:
--accept-flake-config

# Inside you have all the needed tools

# These will provide you with the amazing kuzu-explorer which allows you to run queries to the database.
kuzu-up
# And
kuzu-down

# Inside the devenv you also have access to Mielisearch

# Inside the devenv pre-commits are setup with all other checks so that is the easiest way to make a commit to the repo.

Alternative way

If you prefer not to use Nix, you can still contribute by using different installation methods, and taking care of installing required tools manually.

Tools needed: