zero2prod_axum/README.md

TODO: Add general information about this project

TODO: Explain usage of docker vs podman

TODO: explain DB migration

To migrate a already deployed and running database, use

SKIP_DB_RUN=true ./scripts/init_db.sh

Contribution

Conventions are enforced through commitizen using pre-commit. Commits that do not comply with the conventions will be rejected.

Prerequisites for developers are:

• podman
• postgresql-client
• sqlx
• commitizen
• pre-commit

Current contribution workflow is:

0. TODO: fork/clone repo and install commitizen and pre-commit
1. Modify repo
2. Use cz c to add a commit
3. Push changes
4. Open pull/merge request

Maintainance

Versioning:

TODO; explain versioning

Check for unused dependencies:

Requirement: Needs cargo install cargo-udeps --locked

cargo +nightly udeps --all-targets

Test with tracing output:

Requirement: Needs cargo install bunyan

TEST_LOG=true cargo test | bunyan