Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.65 KB

DEVELOPMENT.md

File metadata and controls

62 lines (41 loc) · 1.65 KB
Raw

Developer Docs

Development Environment

Prerequisites

Cargo Specific Prerequisites

rustup target add wasm32-unknown-unknown &&
cargo install trunk tauri-cli wasm-pack

Running the Project

Two scripts are provided to run the project:

  • ./run.sh - This script will build the project and run
  • ./build.sh - This script will build the project

Command line options, for both scripts, are as follows:

  • --release - Build the project in release mode
  • --debug - Build the project in debug mode. Default
  • --clean - Clean the project before building
  • --web - Build as a web project
  • --standalone - Build as a standalone project. Not yet implemented

Providing commits

There is some linting that is done for each Pull Request, however, it isn't as full featured as pre-commit. Please either install pre-commit as a hook to this git repo via:

pre-commit install

Which will automatically run all of the pre-commit hooks on each commit. Or you can run the pre-commit hooks manually via:

pre-commit run --all-files

Speaking of linting

To keep formatting consistent, cargo fmt is required to be run before each commit. This can be done via:

cargo fmt

Additionally, clippy is also required to be run before each commit. This can be done via:

cargo clippy

Clippy has been set up to be a bit more strict than the default settings. This is to ensure we are writing the best code possible.