Managing money is harder than ever, especially for young adults, students, and people living paycheck to paycheck. Rising costs of living mean that even small emergencies or impulsive spending can cause major financial stress. Existing finance apps are often too complicated, too time-consuming, or designed for people who are already financially savvy, leaving many without accessible tools to build healthier financial habits. OVER-SAVE was created to close this gap by making budgeting approachable, supportive, and motivating.

OVER-SAVE is a budget-tracking application that combines essential features with unique, behaviour-changing tools. Users can track expenses and income, set monthly budgets, manage subscriptions, define savings goals, and view progress through clear dashboard visualisations. OVER-SAVE introduces gamification through BudgetCoins, which reward good financial habits and can be redeemed for perks. Together, these features make budgeting not just about tracking, but about helping people save smarter and stay on track.

• Expense & Income Tracking: record transactions with custom categories.
• Budget Management: set and monitor monthly budgets to stay on target.
• Savings Goals: define goals and track progress over time.
• Subscription Tracking: keep tabs on recurring payments and avoid surprises.
• Financial Dashboard: view clear visualisations of spending, saving, and trends.
• Data Import/Export: back up or transfer your financial data easily.
• Gamification with BudgetCoins: earn and redeem rewards for building positive financial habits.

This application runs using Java 17 and Gradle 9.1 alongside PostgreSQL 17.

1. Install PostgreSQL 17

   For MacOS:

   brew install postgresql@17
   echo 'export PATH="/opt/homebrew/opt/postgresql@17/bin:$PATH"' >> ~/.zshrc
   source ~/.zshrc
   brew services start postgresql@17
   
   # Check installation
   psql --version

   To start a PostgresSQL service: sudo service postgresql start

2. Set up user and database

   Ensure that the user postgres exists on your system by running psql -U postgres in your terminal. If an error occurs, set up the user by running the following commands:

   psql -d postgres
   postgres=# CREATE USER postgres WITH SUPERUSER PASSWORD 'replace-me';
   postgres=# \q
   

   The postgres user should now be set up. To set up the database:

   psql -U postgres or sudo -u postgres psql
   postgres=# CREATE DATABASE unhinged;
   

3. Navigate to project and run:

   ./gradlew bootRun

The default base URL is http://localhost:8080/.

4. To run all tests and produce a coverage report, run:

   gradle jacocoTestReport

This should produce a html report in project/build/reports/jacoco/test/html.

System-wide defaults live in project/src/main/resources/application.properties. Before running locally or deploying:

• Create project/src/main/resources/application-local.properties (ignored by Git).
• Mandatory overrides:
  • spring.datasource.url, spring.datasource.username, spring.datasource.password
  • spring.mail.username, spring.mail.password
  • OAuth client secrets: GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET
  • APP_SESSION_SECRET for signing session tokens
• Example local override file:

  spring.datasource.url=jdbc:postgresql://localhost:5432/elec5619
  spring.datasource.username=oversave
  spring.datasource.password=strong-password
  spring.mail.username=your.address@example.com
  spring.mail.password=app-specific-password
  app.session.secret=replace-with-random-string

Visit our API documentation page for more details on our REST API.

| name            |
|-----------------|
| Aryan Adhikari  |
| Antriksh Dhand  |
| Kartik Nair     |
| Taozhao Chen    |
| Joey Chen       |