API

Note

For the API development, you need to install the Rust compiler.

Check the dedicated documentation section for more information.

You can compile without running with:

cargo build

Then you can run ./target/debug/panoramax-api --db-url=postgres://username:password@localhost:5432/panoramax.

If you also want to quickly know if the compilation is ok you can do

cargo check

For development purpose, you might want hot reload to run build on file changes. To do this, install cargo-watch:

cd api
cargo install cargo-watch

then

RUST_LOG=info PORT=9001 DB_URL=postgres://username:password@localhost:5432/panoramax cargo watch -x run

Matomo

Usage statistics can be sent to a configured matomo instance by providing it's url/site-id when running the API.

The environment variables for this are:

To run the tests:

cd api
cargo test

All files should be formated with rustfmt:

cargo fmt