Welcome

This is the technical documentation for Settle Up. It contains information about the database, server tasks & functions, common algorithms and anything else useful to developers.

Settle Up comprises the following parts:

• Apps
  • Android
  • iOS
  • Web
    • Sandbox
    • Live
  • Windows (obsolete)
• Firebase Backend
  • Sandbox
  • Live
  • Links – link.settleup.app used to open app sharing links
• Product website – https://settleup.io/
• Weblate for localizations
• Admin – command line tool for management & support
• Tests – Gherkin tests shared accross platforms
• Typescript library – Library (npm package) used in Web and Backend

On a high level, individual apps talk directly to Firebase Database. The database is safe-guarded by security rules and observes changes made to it which trigger Cloud Functions, which can further manipulate database data server-side. User authentication is done using Firebase Auth.

Users can create groups and invite their friends using group sharing links. These links either open the app directly or lead to our link.settleup.app domain which opens the web app.

Find more details in the respective sections of this documentation. Also, check out the history if you want broader context.