Slack app for gathering information about loans between members of the team.
Currently there are three commands that can be executed in channel view:
money-balance
- show balances between user and all other team membersmoney-history
- show history of all payments betweenmoney-add @user value description
- add new payment between@me
and@user
with specificvalue
.Description
is optional field.
There is a special Bot called Money
that will give notifications about actions that relates to @me
.
- You can create payment between yourself and one other user - by default user that invokes command is a payer and user provided in parameters is receiver. To revert the relationship pass negative number as
value
. - There is no distinguish between payment for something and returning the money. You only can write it in
description
. - You cannot filter or sort results from
money-history
ormoney-balance
commands. - It's not possible to delete payment that was accepted by the server. To revert it just make another payment with reverted value.
All required configuration is stored in application-dev-sample.yml
file. Copy it do application-dev.yml
and add proper configuration information.
To make this file be loaded during startup you need to activate app profile dev
. Easiest way in local setup is to set environment variable SPRING_PROFILES_ACTIVE
. More information available at Spring Boot Reference.
Application uses Neo4J to store data. Easiest way to install it is by using docker-compose.yml
.
Current production version runs on Heroku
cloud. Neo4J
is provided by GrapheneDB
add-on.
To properly run application you need to specified all required env variables. They are listed in application-heroku.yml
file.
Additionally you need to activate heroku
profile.
You can also prepare Docker image using provided Dockerfile
Pull requests with new features and bugfixes are welcome :)