OOPP TEAM 28 Splitty Application

This document serves to guide you and answer all your questions regarding the use of the Splitty application. Use this as a reference. Start documenting and managing your Events!

Start up:

• To start the application, FIRST start the local Server. Wait a couple of seconds until the Server is running and the Spring signature has appeared.
• Now you can start the Client, and after a few seconds the User Interface should show up. You will now see the Start Screen.
• For running the client, we recommend running the client.Main file instead of the Gradle task, to avoid any resources being unable to load. Everything should work fine in both ways, but we have used the client.Main way much more often

Note: Make sure to wait until the Server really has started running

StartScreen:

• Check if Splitty is set to you preferred language. Splitty supports English, Dutch and Romanian! You can even add a language of your choice. To see how this works, take a look at the Settings Page.
• Create a new Event in the Start Screen by entering an Event name in the upper text field. To finalize it's creation, press the button next to it ("Create" in English).
• If you have received an invite-code from friends or family, enter it in the second text field and press "Join" to enter that Event!
• If you create or join an event, the Event will show up in the Event List that takes up the lower half of the page. Click on an Event to access more of it's details and start modifying it.

Settings page:

• Enter you e-mail address so Splitty can save it for you!
• Next to "Theme" there is a drop-down menu located that allows you to choose a different theme you might prefer. In total there are 8 possible themes to choose from, but only 7 of them appear in the drop-down menu. To activate the secret 8th theme:*
• You can also add a currency you prefer working with. Currently, the app only supports EUR, USD and CHF.
• Under "Splitty Server" you can choose to connect to a different Server. Enter the Server inside the text field and connect to it by clicking the "Update Server" button.
• Your preferred choices of language and currency get stored. If you want Splitty to return to it's default state, like when you first started the app, click on "Restore Defaults".
• Click on "Download language template" to download a language template and start adding your own language. Fill in the translation for all values in the template and send them to us! We'll make sure to add the language.
• IF you are an administrator, you will have access to a password allowing you to enter the Admin Overview. Click on "Generate Password", check the Server terminal/console as the password will be displayed here. Copy this password and enter it in the text field. Press the arrow to enter the Admin Overview (if password was entered correctly).

Admin Overview:

• As an administrator you get to see all the created Events that exist in the database in a table format.
• You can click on an Event to get the option to delete it from the database or download a JSON dump of the Event to create backups.
• Furthermore, you can import JSON dumps of Events with the top left button on the screen to add backup events. The Event will be immediately visible in the Admin Overview.
• You can click on the column names (Event Name, Creation Date and Last Activity) to sort on name , creation date and last activity. Clicking on the column name again will reverse the sorting.
• When you now go back to the Settings page you see that you will not have to repeat entering the administrator password to enter the Admin Overview. But if you close the app you need to enter it again.

Event Overview (using WebSockets for the Participant list!):

• Add participants to your event by entering a name in the most left text field and clicking on the button next to it.
• Participants will then show up in a list view for participants. You can rename them by clicking on them and entering a new name.
• You can add an expense to a participant by clicking "Add Expense".
• Once you added expenses you can see them in a list view.
• Filter based on date, payer, participants and the tags of the expenses. Reset filters when necessary.
• Rename the file with the text field underneath the current name.
• You can modify expenses by clicking on them in the list view. You will enter a page similar to the one when adding expenses. Here you also get the option to remove/delete expenses.
• A statistics page is available, enter it by clicking the statistics button right next to the "Add Expense" button.
• Settle debts by using the "Settle Debts" button.

Add Expense page:

• Choose the payer from the participants.
• Show what the payer paid for.
• Enter the amount this participant paid and choose the currency in which it was paid.
• Enter the date of the payment.
• You can include or exclude members from an expense, so that they are not responsible for paying anything back.
• Add a tag to an expense (Food, Travel, etc). Splitty provides three standard tags, but you can also add your own!
• Confirm the expense by clicking on the check mark button on the bottom left.
• Create you own tags in by clicking the plus button.

Add Tags page:

• Add tags by giving them a name and color. Confirm the creation of the tag to make it usable immediately for adding expenses.

Settle Debts (uses LongPolling for the Expense view!):

• Here you will see the total amount of money for all expenses made for this Event.
• In the bottom list view you see the money owed by everyone and the money everyone is owed ("-10" meaning participant is owed 10EUR).
• Select participants down below to transfer money to one another. (From p1, To p2, amount= 10, click on the check mark to send 10EUR from p1 to p2).
• Click on "Settle Debts" to quickly settle debts.

Keyboard shortcuts:

Start Screen:

• alt + c = focus on Create Event text field
• alt + shift + c = create an Event after entering it's name
• alt + j = focus on Join Event text field
• alt + shift + j = join the Event after entering invite-code
• alt + s = go to Settings page
• alt + l = focus on Language button
• alt + e = focus on Event list view
• ENTER = same as "alt + shift + c" OR "alt + shift + j". Also = enter Event when focussed on.
• ESCAPE = close the application.

Setting page:

• alt + e = focus on e-mail text field
• alt + shift + e = update e-mail
• alt + t = focus on Theme button
• alt + c = focus on Currency button
• alt + s = focus on Server text field
• alt + shift + s = update Server
• alt + a = generate Admin password
• alt + p = focus on password text field
• ENTER = validate password
• ESCAPE = go back to Start Screen

Event Overview:

• alt + n = focus on renaming text field
• alt + shift + n = rename title
• alt + p = focus on participant text field
• alt + shift + p = add participant
• alt + e = focus on expense list view
• alt + shift + e = add expense
• alt + c = copy invite-code
• alt + d = enter Debt Settlement page
• alt + l = focus on Language button
• ENTER = rename OR add participant
• CTRL + z = undo
• ESCAPE = go back to Start Screen

Add Expense page:

• alt + p = focus on who paid drop-down
• alt + i = focus on "What for?" text field
• alt + c = focus on "How much?" text field
• alt + d = focus on date
• F2 = focus on currency
• F1 = confirm
• ESCAPE = go back to Event Overview

Edit Participant page:

• F2 = focus on name text field
• F1 = confirm
• ESCAPE = go back to Event Overview
• DELETE = delete participant

Event Statistics page:

• ESCAPE = go back to Event Overview

Debt Settlement page:

• ENTER = transfer the amount entered when focussed on amount text field
• ESCAPE = go back to Event Overview

*In the digital realm, where codes entwine,
A secret lies hidden, a theme so fine.
Press T and U together, with fingers deft,
Unlock the magic of TU Delft!