Arbie

Arbie is a greedy crypto pirate!

Run

Run Brig with docker-compose:

cd Brig && docker-compose up -d

Getting started

Develop

Instructions for developing arbie using docker or virual-env.

To setup the development environment run:

./gradlew venv && source .venv/bin/activate && ./gradlew setup

It will run the steps bellow and make sure that all tools required for Arbie are setup.

Docker

The arbie repository can be built using docker. This is probably the simplest approach if you just want to get things building.

docker build . -t arbie

You can now use the newly created docker image to build and test with.

test:

docker-compose run --rm arbie ./gradlew tAL

Virtual-env

Create a virtual env:

./gradlew venv

Run virual env:

source .venv/bin/activate

Install requirements:

./gradlew pip

lint:

./gradlew lint

Commits

Arbie works with semantic-release and therefore has a special commit style. We use Angular style commits. A helpful tool for ensuring the correct commit style is commitizen.

Simply run when commiting:

cz c

Pre commit hooks

To enforce code standard we use pre-commit it manages pre commit hooks.

Run to setup:

pre-commit install