snaeil/zero2prod_axum
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
No description
73 commits 1 branch 0 tags 159 KiB
Find a file
Exact
Sandro Eiler 6e07d9c33a
Some checks failed
Rust / Test (push) Has been cancelled
Details
Rust / Rustfmt (push) Has been cancelled
Details
Rust / Clippy (push) Has been cancelled
Details
Rust / Code coverage (push) Has been cancelled
Details
test: move logic to helpers
2024-04-18 23:48:34 +02:00
.github/workflows chore: first working version with integration test 2023-11-12 14:11:13 +01:00
.sqlx build: make project deployable via docker/podman 2024-02-07 12:07:03 +01:00
configuration feat: red test implementation of email confirm 2024-04-18 14:31:06 +02:00
migrations feat: add subscription_tokens table 2024-03-04 21:25:55 +01:00
scripts feat: add configurability 2024-01-01 14:36:02 +01:00
src docs: clean up repo and add doc strings 2024-04-18 23:24:11 +02:00
tests/api test: move logic to helpers 2024-04-18 23:48:34 +02:00
.cz.toml build: update commitizen config 2023-12-28 22:17:36 +01:00
.dockerignore build: reduce podman/docker image size 2024-02-07 12:14:51 +01:00
.env refactor: changes 2024-01-21 22:00:10 +01:00
.gitignore first 2023-07-01 20:34:21 +02:00
.pre-commit-config.yaml feat: add configurability 2024-01-01 14:36:02 +01:00
Cargo.lock chore: update validator to 0.17 2024-03-05 14:06:55 +01:00
Cargo.toml chore: update validator to 0.17 2024-03-05 14:06:55 +01:00
CHANGELOG.md chore: add pre-commit config 2023-12-28 22:04:32 +01:00
commitlint.config.js chore: add pre-commit and format files 2023-10-21 13:47:06 +02:00
Dockerfile build: add caching for container image creation 2024-02-07 13:35:13 +01:00
README.md feat: red test implementation of email confirm 2024-04-18 14:31:06 +02:00

README.md

TODO: Add general information about this project

TODO: Explain usage of docker vs podman

TODO: add https://crates.io/crates/cargo-semver-checks

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:

  1. TODO: fork/clone repo and install commitizen and pre-commit
  2. Modify repo
  3. Use cz c to add a commit
  4. Push changes
  5. 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 more output:

cargo test -- --nocapture

Test with tracing output:

Requirement: Needs cargo install bunyan

TEST_LOG=true cargo test | bunyan