SpareSti API

Description

The API backend of sparesti.app. SpareSti is designed to make saving fun. The app is integrated with your online bank, therefore it has an overview of what your money is being spent on and can provide you with personalized saving tips based on this information. The app is suitable for all saving goals and offers motivation and tips tailored to your desires. Since we know that saving money can be difficult, SpareSti automatically deposits money into your savings account when you complete challenges. Based on your saved funds, the feed will give you personalized tips on how your money can be invested, and you will be able to set up a budget that provides you with the overview you need to make informed choices.

Links

• Website: https://sparesti.org/
• Frontend: https://gitlab.stud.idi.ntnu.no/idatt2106-2024-07/frontend
• Jacoco Test Coverage: https://backend-idatt2106-v24-7-120575f97d1f5ac63c49fe399f685f116b780a1.pages.stud.idi.ntnu.no

Prerequisites

Before you can run the application, ensure you have the following software installed on your system:

• Java (v17): The application is built using Java, so you'll need the JDK to compile and run it. Download Java JDK v17
• Maven: Maven is used for dependency management and to build the application. Download Maven
• MySQL: The application uses MySQL as its database. Download MySQL
• Docker: Docker is used for creating containers for the application. Download Docker

Getting Started

1. Clone SpareSti:

Clone with SSH:

git@gitlab.stud.idi.ntnu.no:idatt2106-2024-07/backend.git

Clone with HTTPS:

https://gitlab.stud.idi.ntnu.no/idatt2106-2024-07/backend.git

2. Install dependencies

mvn clean install

3. Run the application

mvn spring-boot:run 

Docker

How to run the application with docker. NOTE: You need to have docker pre-installed: Click here

1. Build the Docker image

docker build -t your-image-name .

2. Verify the image was created

docker images

3. Run the Docker container:

docker run -d --name your-container-name -p 8080:8080 your-image-name

Tests

1. Run tests

mvn clean test

2. Jacoco Coverage Report

Gets generated when running mvn clean test and are located in:

/target/site/jacoco/index.html

Database

To configure the database go to src/main/resources/application.yml

Here is the current configuration:

spring:
  datasource:
    url: jdbc:mysql://128.199.53.153:3306/sparesti
    username: username
    password: password

To configure the test database go to src/test/resources/application.yml

Here is the current configuration:

spring:
  datasource:
    url: jdbc:mysql://129.241.98.39:3306/sparesti_test
    username: user
    password: Password1.

When you run the application the database will be populated with test-data.

Contributors

The individuals who contributed to the project:

• Anders Høvik
• Andreas Kluge Svendsrud
• Henrik Dybdahl Berg
• Henrik Teksle Sandok
• Jens Christian Aanestad
• Victor Kaste
• Viktor Grevskott