Web-App for repaying friendly debts

What is IOU (I owe you)?

IOU (I owe you) is a web-app that allows users to keep track of debts they owe to friends or debts friends owe to them. The app is designed to be simple and easy to use, with a focus on user experience.

This ASP.NET web-app is built using the MVC design pattern, and uses Entity Framework Core to interact with a SQL Server database. Simply build in a docker container for easy testing and use.

It implements SMTP email sending and QR Generation using QR-Code-Generator.coms API.

The design of the app is build on Bootstrap and created for a clean and simple user experience.

Table of Contents

• Installation
• Usage
• Examples

Installation

This project is deployed as a docker container including a MySQL container, so no external database setup is needed. You can simply clone this repository, build the docker containers and run them (see below).

Adding API keys and SMTP settings

Most of the app runs without the API keys. But without the SMTP settings, the app will not be able to send emails and thererfore a registration will not be possible.

To add the SMTP settings and the QR-Code API token, you need to adjust the docker-compose.yml file.

environment:
  - QR-CODE-API-KEY=yourqrcodekey
  - SMTPHOST=yourhostname
  - SMTPPORT=yourport
  - SMTPUSERNAME=yourusername
  - SMTPPASSWORD=yourpassword
  - FROMMAILADDRESS=yourmailaddress

Enter the API key from QR-Code-Generator.com and your SMTP settings right in there and build the docker container.

Start the app

git clone https://github.com/dermrvn-code/IOweYou

cd IOweYou

docker-compose build
docker-compose up

The app should now be running on localhost:5000.

Usage

The app is designed straight forward. After starting the app, you can register a new user. For testing and demonstration purposes, you can use one the following credentials:

isd_user isdpassword

second_isd_user isdpassword2

After logging in you have an overview over all your balances and transactions. In the top right bar you can search for other users (like the second user above) and add a transaction of lets say 2 coffees.

If you login as the second user, you will see the transaction and the balance of the first user as a positive value. You can then resolve this transaction and waive the debt.

Over the account tab you can adjust your profile and also see your accounts QR code. This QR code can be scanned by other users to send you something.

Examples

Dashboard

Sending Page

Transactions Page

Account Page (with QR-Code)

(Back to top)