rbino / tigerbeetlex

An Elixir client for TigerBeetle

TigerBeetlex

Elixir client for TigerBeetle.

Usage

More documentation is coming, for now check out the integration test in the test directory.

Installation

If available in Hex, the package can be installed by adding tigerbeetlex to your list of dependencies in mix.exs:

def deps do
  [
    {:tigerbeetlex, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/tigerbeetlex.

Contributing

Setup

$ git clone --recurse-submodules https://github.com/rbino/tigerbeetlex.git 
$ cd tigerbeetlex/src/tigerbeetle
$ scripts/install.sh
$ ./tigerbeetle format --cluster=0 --replica=0 --replica-count=1 0_0.tigerbeetle
$ ./tigerbeetle start --addresses=3000 0_0.tigerbeetle

see the TigerBeetle documentation for more info. In a new terminal session:

$ cd tigerbeetlex
$ mix deps.get

and finally ensure the tests pass:

$ mix test

License

Copyright 2023 Riccardo Binetti

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.