Antidote

Welcome to the Antidote repository, the reference platform of the SyncFree European Project and the LightKone European Project

You will find all information in the documentation at http://antidotedb.eu.

For benchmarking Antidote deployments, we currently use basho bench.

Development

Antidote requires Erlang 21 or greater.

Use the following Makefile targets to build and test antidote:

# compile the project:
make compile

# run the unit tests:
make test

# run the system tests:
make systests

# Run dialyzer to check types:
make dialyzer

# Open a shell:
make shell

# Build a release:
make rel

Code style

Before commiting code run make lint to check the code style.

In addition there are the following rules which are not checked automatically:

• Indentation should use 4 spaces (no tabs)
• Exported functions must be documented and have a type specification

Working on dependencies

When working on dependencies of Antidote it can be helpful to use them as Checkout Dependencies:

• Create a folder named _checkouts in your antidote folder (next to the _build folder)
• Clone the dependency into that folder. The folder name in _checkouts must be the name of the dependency in rebar.config. Note that symbolic links in the _checkouts folder are ignored.
• When running a rebar3 task on Antidote, it will always use the latest version from the dependencies. It will also recompile all other dependencies, which can be avoided by patching rebar3