Rends moi ma tune

Rends moi ma tune (abbreviated Rmmt) is a free software multi-user account management. Rmmt allow you to organize some expenditures and track who owes money to who in a group.

Rmmt aims to be accurate, simple and ergonomic.

Installation

Rmmt REST server being based on peewee it is supposed to support a wide range of database systems. Currently, only SQLite3 and Postegresql are eavily tested. You are more than welcome to test Rmmt with another database systems.

Here is the 3 steps required to run Rmmt web app.

Install web app dependencies:

cd client/ && npm install

Build web app and install Rmmt:

./waf-1.8.21 configure build install --destdir=$(pwd)

Then go to built server directory and run Rmmt server:

cd usr/local/share/rmmt/server/
./server.py --static ../static/ --init

--init option should only be used on first run as it will create the database tables

Here you go, Rmmt should be running on http://127.0.0.1:8080

Durable installation

In order to have a more durable installation you should consider using another web server and database. Here the procedure to run Rmmt server behind nginx, with gunicorn and postgresql.

First you should build and install Rmmt to a standard directory:

./waf-1.8.21 configure build install

Ensure your database is configured to use UTF-8 encoding, either with initdb:

initdb -D /var/postgresql/data -U postgres -E UTF8 -A md5 -W

or when creating the database:

CREATE DATABASE rmmt WITH ENCODING 'UTF-8' OWNER rmmt;

Configure your nginx to proxy request to gunicorn and serve static files:

server {
        listen 80;
        root /usr/local/share/rmmt/static/;

        location /api/ {
                proxy_pass http://127.0.0.1:8080;
        }
}

And finally run Rmmt with gunicorn (here with 4 workers):

/usr/local/share/rmmt/server/server.py --db postgresql://user:password@localhost:5432/rmmt --server gunicorn -w 4

Architecture

Rmmt is mainly a REST server based on:

• peewee
• bottle

We provide a default web client based on:

• angularjs
• foundation-sites

API

Up-to-date documentation of the API can be found in server/server.py.

Server manual

Up-to-date server manual is available with:

./server.py --help

usage: server.py [-h] [-l HOST] [-p PORT] [--db DB] [--static STATIC]
                 [--server SERVER] [--init]

Rendsmoimatune

optional arguments:
  -h, --help            show this help message and exit
  -l HOST, --listen HOST
                        IP address to bind to
  -p PORT, --port PORT  Port to listen to
  --db DB               Database scheme to connect to
  --static STATIC       Path to static files
  --server SERVER       Bottle server type
  --init                Initialize database

Client developement

Install dependencies

npm install

Serve with hot reload at localhost:8000 and proxy server request to localhost:8001

npm run dev

Build for production with minification

npm run build

For detailed explanation on how things work, checkout the guide and docs for vue-loader.

License

Copyright (c) 2016 Paul Fariello paul@fariello.eu

Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.