Getting started

Depending on you setup, there are several different ways to install. We recommend the Flatpak method for most people.

If you are curious or even want to contribute, you can build and install from source.

Flatpak

Requirements

• flatpak runtime
• a way to install flatpaks

Local installation

Local installation is not the recommended way. If you want to tinker or early adopt, you can do it. Other users should for the flathub release (or a CI release, should that be provided in the future).

Build

flatpak-builder --force-clean build-dir build-aux/dev.bitritter.BitRitter.Devel.json

Install

flatpak-builder --force-clean --user --install-deps-from=flathub --repo=repo --install builddir build-aux/dev.bitritter.BitRitter.Devel.json

coming soon

Flathub installation

coming soon

From source

Requirements

Executables

  git
  cargo

Build dependencies

This list is derived from the nix flake i use for building. If you also use nix, you can just use nix develop after cloning the repository. Packages may differ in name on other distributions. For example on debian bases systems, you might see versions ending with -dev or similar.

Core packages

Usually, you cannot compile without these.

 openssl
 cacert
 gtk4
 wrapGAppsHook4
 libadwaita
 gobject-introspection
 pkg-config

Optional

These are not neccessary for build, but proven useful

 lldb # if you want to debug
 rust-analyzer # most IDEs need this for convenience
 clippy # cargo linter
 sqlx-cli # if you plan on migrating/changing databases
 rustfmt # auto format code

Clone the project

git clone https://codeberg.org/Chfkch/bitritter.git

Compile the project

This step is optional if you want to run the app right away, since the next chapter will also compile the project, if not done before.

# Usually --release should be added, except when you need debug symbols
# Otherwise starting/unlocking might be slow, depending on the size of your vault
cargo build --release

Run the executable

If all goes well, there will be a file bitritter in your target/release folder. Run it with the following command

cargo run --release

# Or if you want to run the executable directly
./target/release/bitritter