This repo is an axum backend server written in Rust and serving a GraphQL API abstracting the ARGA index.

Getting Started

This repo is built against the latest stable version of rust.

The configuration of the backend server happens via environment variables. First copy the .env.sample file:

cp .env.sample .env
vim .env

and then set the variables to point at your Solr and arga-frontend services. The frontend service is only useful for development as it'll add your nodejs server to the CORS list allowing it to make requests. In production this wont be necessary.

To run a development server:

cargo run --bin arga-backend

To build a production version and serve it with the nextjs server (optional)

cargo build --release
./target/release/arga-backend

Reproducible Builds

Included in the repo is a devenv configuration to enable a declarative and reproducible environment. This leverages the nix package manager to provide both needed system dependencies as well as convenient developer tools without having to worry about version compatibility.

To get started install devenv and then enter the shell by running:

devenv shell

This will take some time to download rust and various tools like rust-analyzer. Once inside the above commands in Getting Started should work with the correct dependencies. If you're messing around with the devenv or nix flake files don't forget to occasionally do a garbage collect by running:

devenv gc

This will remove any dependencies no longer used. Keep in mind that the nix package manager does not use your system packages so it might take up more disk space than you would expect. For example if installing nodejs it will also install the locked dependencies of nodejs as well, and so on.

direnv

To avoid clobbering other workflows the .envrc file created by devenv isn't committed. To automatically enter the shell when you enter the repo directory add the following .envrc file to the project root:

watch_file devenv.nix
watch_file devenv.yaml
watch_file devenv.lock
eval "$(devenv print-dev-env)"