# Nextcloud Cospend ��

![CI](https://github.com/eneiluj/cospend-nc/workflows/CI/badge.svg?branch=master&event=push)
[![coverage report](https://github.com/eneiluj/cospend-nc/raw/gh-pages/coverage.svg)](https://eneiluj.github.io/cospend-nc/)
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/moneybuster/localized.svg)](https://crowdin.com/project/moneybuster)

Nextcloud Cospend is a group/shared budget manager.
It was inspired by the great [IHateMoney](https://github.com/spiral-project/ihatemoney/).

You can use it when you share a house, when you go on vacation with friends, whenever you share money with others.

It lets you create projects with members and bills. Each member has a balance computed from the project bills.
This way you can see who owes the group and who the group owes. Ultimately you can ask for a settlement plan telling you which payments to make to reset members balances.

Project members are independent from Nextcloud users.
Projects can be accessed and modified by people without a Nextcloud account. Each project has an ID and a password for guest access.

[MoneyBuster](https://gitlab.com/eneiluj/moneybuster) Android client is [available in F-Droid](https://f-droid.org/packages/net.eneiluj.moneybuster/) and on the [Play store](https://play.google.com/store/apps/details?id=net.eneiluj.moneybuster).

[PayForMe](https://github.com/mayflower/PayForMe) iOS client is currently being developped!

## Features

* ✎ create/edit/delete projects, members, bills, bill categories, currencies
* ⚖ check member balances
* �� display project statistics
* ♻ display settlement plan
* �� automatically create reimbursement bills from settlement plan
* �� create recurring bills (day/week/month/year)
* �� optionally provide custom amount for each member in new bills
* �� link bills with personal files (picture of physical bill for example)
* �� guest access for people outside Nextcloud
* �� share projects with Nextcloud users/groups/circles
* �� import/export projects as csv (compatible with csv files from IHateMoney and SplitWise)
* �� generate link/QRCode to easily import projects in MoneyBuster
* �� implement Nextcloud notifications and activity stream

This app is tested on Nextcloud 20+ with Firefox 57+ and Chromium.

This app is under development.

�� Help us to translate this app on [Nextcloud-Cospend/MoneyBuster Crowdin project](https://crowdin.com/project/moneybuster).

⚒ Check out other ways to help in the [contribution guidelines](https://github.com/eneiluj/cospend-nc/blob/master/CONTRIBUTING.md).

Link to Nextcloud application website : https://apps.nextcloud.com/apps/cospend

## Donation

I develop this app during my free time.

* [Paypal: <img src="https://raw.githubusercontent.com/stefan-niedermann/paypal-donate-button/master/paypal-donate-button.png" width="100"/>](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66PALMY8SF5JE) (you don't need a paypal account)
* [Liberapay : ![Donate using Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/eneiluj/donate)

## Documentation

* [User documentation](https://github.com/eneiluj/cospend-nc/blob/master/docs/user.md)
* [Admin documentation](https://github.com/eneiluj/cospend-nc/blob/master/docs/admin.md)
* [Developer documentation](https://github.com/eneiluj/cospend-nc/blob/master/docs/dev.md)
* [CHANGELOG](https://github.com/eneiluj/cospend-nc/blob/master/CHANGELOG.md#change-log)
* [AUTHORS](https://github.com/eneiluj/cospend-nc/blob/master/AUTHORS.md#authors)

## Known issues

* ...

Any feedback will be appreciated.

## Screenshots

![1](https://github.com/eneiluj/cospend-nc/raw/master/img/screenshots/cospend1.jpg)
![2](https://github.com/eneiluj/cospend-nc/raw/master/img/screenshots/cospend2.jpg)
![3](https://github.com/eneiluj/cospend-nc/raw/master/img/screenshots/cospend3.jpg)
![4](https://github.com/eneiluj/cospend-nc/raw/master/img/screenshots/cospend4.jpg)

## Nightly

:warning: Make sure to only use nightly builds on test Nextcloud instances.

To install the latest nightly, you can either
* download it from https://apps.nextcloud.com/apps/cospend and replace
the app directory manually in `nextcloud/apps`
(make sure you give cospend directory's ownership to your webserver user)
* use this occ command:
```
occ app:update --allow-unstable cospend
```
When you want to get back to stable releases,
just disable and remove the app from app settings and reinstall it. You won't loose any data.