thakaresandCopilot
2ac6c81dfe
- Prevent 'nx9-wg version' from creating data directories by avoiding database initialization. - Create parent directories when an explicit --database path is provided. - Redact printed generated administrator passwords; announce file path or redact instead. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1.3 KiB
1.3 KiB
Development and Contributing Guide
Environment Setup
- Rust Toolchain:
rustcandcargo1.85+ (Edition 2024). - SQLite3 development headers (for
sqlx-sqlite).
Workspace Structure
.
├── Cargo.toml
├── Cargo.lock
├── config.example.toml
├── nx9-wg.service
├── Dockerfile
├── src/
│ └── main.rs
├── crates/
│ ├── nx9-core/ # Domain models, crypto, config, validation
│ ├── nx9-db/ # SQLite schema, migrations, repositories
│ ├── nx9-wireguard/ # WireGuard controller, .conf builder, QR engine
│ ├── nx9-network/ # Forwarding, routing, nftables
│ ├── nx9-api/ # Axum API, WebSocket, Reconciler, Backup
│ └── nx9-ui/ # Dioxus UI shell
└── docs/ # Documentation suite
Running Quality Gates
Before submitting changes, all mandatory quality gates must pass:
# 1. Format check
cargo fmt --all -- --check
# 2. Workspace check
cargo check --workspace
# 3. Unit and integration tests
cargo test --workspace
# 4. Strict clippy with warnings denied
cargo clippy --workspace --all-targets --all-features -- -D warnings
# 5. Marker scan
git grep -n -E 'TODO|FIXME|XXX|HACK|unimplemented!|todo!|panic!' src/ crates/