Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 3.22 KB

database.md

File metadata and controls

49 lines (38 loc) · 3.22 KB
Raw

Database

  • BalanceMe's database serves multiple purposes: it must save the individual user's preferences and settings,such as language, name and currency while simultaneously saving his or a group's incomes and expanses in such a way,in order to minimize the impact on the app's performance.

BalanceMe's database consists of three main elements: Firebase authentication table- to utilize Firebase's various authentication functions

  • Email- unique identifier for the other collections.
  • In addition to the standard email and password sign in, sign in by Google or Facebook is possible
  • Only 2 providers ,at most, can be linked at a time

General info- Individual user's collection. Identified by the user's email contains the following:

  • End of month- the day in which the user wishes to archive last month's entries.
  • First name and last name- the user's first name, and last name can be changed in the profile settings.
  • Dark mode- whether the user switched the app to dark mode or not.
  • Currency- the currency number which is used to document the user's incomes and expanses.
  • Group name- the name of the group which the user is a part of.
  • Profile image- saved in Firebase storage, with its email being a unique identifier.
  • BelongsWorkspace- the collection of the names of workspaces, a user belongs to, their invitations to other workspaces, as well as joining requests.
  • UserMessages- all joining requests and invites from other workspaces: contains the message type, user it was sent to, and the workspace it was sent from

for simplicity's sake, a user starts in a singleton workspace with his own email as a name- the default workspace can be deleted, a user can open and join multiple workspaces at a time, with each workspace having a unique name. categories and transactions are tracked separately in each workspace. Each user has a workspace users collection, with the following parameters:

  • Leader- the user who opened the workspace, can send invitations to join the workspace, as well as delete it (with the exception of the default workspace)
  • Users- all the user emails who belong to that workspace.

Categories and transactions- a group's collection of transactions- identified by a unique group name

  • Category documents are separated by month/year- each is separated to income categories and expense categories

Each sub category represents types of transactions, with the following attributes:

  • Amount- the sum total of money spent or gained in that category
  • Description- optional textual information about the category
  • Expected - the budget the group allocated to the category
  • Is income - whether the categories reduce the amount of money spent or increase it.
  • Name - the name of the category

Each category has entries which represent individual transactions, with the following attributes:

  • Amount- the amount of money spent or gained in the transaction
  • Date- when has the transaction taken place day/month/year format
  • Description- optional textual information about the entry
  • Is constant - whether the entry is a constant expense/income or a one time entry, for user convenience.
  • Name - the name of the entry