Install Rust as described here.
SQLx is an async, pure Rust SQL crate featuring compile-time checked queries without a DSL.
SQLx-CLI is SQLx's associated command-line utility for managing databases, migrations, and enabling "offline" mode with sqlx::query!() and friends.
It is published on the Cargo crates registry as sqlx-cli and can be installed like so:
cargo install sqlx-cli --features postgresThe following script will start the latest version of Postgres using Docker, create the database and run the migrations.
./scripts/init_db.shThere are 3 steps to building with "offline mode":
- Enable the SQLx's Cargo feature offline
- E.g. in your Cargo.toml, sqlx = { features = [ "offline", ... ] }
- Save query metadata for offline usage
cargo sqlx prepare
- Build
Configuring the backend application is done, preferentially, via environment variables. To make working with environment variables easier during development, we can use .env files to avoid having to define the variables every time.
As a starting point, you can simply cp sample.env .env in this repo and modify the .env file as described by
the comments there.
With everything else set up, all you need to do at this point is:
cargo runIf successful, the API server is now listening at port 8080.
Use cargo-watch for hot reloading the server.
cargo watch -x runRun unit tests with:
cargo testRun behavioral tests with:
cargo test --test cucumberOutput World on fail with:
cargo test --test cucumber -- -vvFormat with:
cargo fmt --checkLint with:
cargo clippy -- -D warningsCheck code coverage:
cargo tarpaulin --verbose --workspaceLicensed under MIT license. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, shall be licensed as above, without any additional terms or conditions.