No description
| .github/workflows | ||
| .sqlx | ||
| configuration | ||
| migrations | ||
| scripts | ||
| src | ||
| tests/api | ||
| .cz.toml | ||
| .dockerignore | ||
| .env | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| commitlint.config.js | ||
| Dockerfile | ||
| 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:
- TODO: fork/clone repo and install commitizen and pre-commit
- Modify repo
- Use
cz cto add a commit - Push changes
- 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