pavex_html

Getting started

Prerequisites

• Rust
• Pavex
• cargo-px
• (Optional but recommended) cargo-hakari

Useful commands

This API is built using the Pavex web framework, which relies on code generation.
You need to use the cargo px command instead of cargo: it ensures that the server_sdk crate is correctly regenerated when the application blueprint changes.

cargo-px is a wrapper around cargo that will automatically regenerate the server SDK when needed. Check out its documentation for more details.

Build

# You can also use `cargo px b`, if you prefer.
cargo px build

Run

# You can also use `cargo px r`, if you prefer.
cargo px run

The command above will launch the API, which will start listening on port 8000. The API will use the dev profile. Check out CONFIGURATION.md for more details.

Test

# You can also use `cargo px t`, if you prefer.
cargo px test

Configuration

The configuration system used by this application is detailed in CONFIGURATION.md.

workspace_hack

The project includes a "utility" crate named workspace_hack. It is used to speed up project builds by forcing eager feature unification.
To understand how it works, check out cargo-hakari's documentation.
To keep workspace_hack up to date, install cargo-hakari and run:

cargo hakari generate && cargo hakari manage-deps -y