Skip to content
Branch: master
Go to file
Code

README.md

Offset

Build Status codecov

Offset is a credit card powered by trust between people.

Warning: Offset is still a work in progress, and is not yet ready for use in production.

Info

License

  • The core crates of Offset are licensed under the AGPL-3.0 license.
  • The crates used as interface for building Offset apps are licensed under the MIT or Apache 2.0, at your option.

Each crate license info can be found in the corresponding crate directory and in the crate's Cargo.toml.

Download

Releases page

Dockerized Offset servers

offset_docker

Building Offset

Install dependencies

  • Install Rust.
  • Install capnproto:
    • On Ubuntu, run: sudo apt install capnproto
    • On macOS, run: brew install canpnp

Rust toolchain version

Offset builds on stable! The toolchain is pinned using the rust-toolchain file.

For testing, run:

cargo test

To build, run:

cargo build --release

Development tools

If you want to hack on Offset, run the following commands to install clippy, rustfmt and rls:

rustup update
rustup component add clippy
rustup component add rustfmt
rustup component add rls rust-analysis rust-src
You can’t perform that action at this time.