Class Buddy Matcher - Group project for SOFTENG 701 Team 1 (Backend).
This project comprises the backend segment (API + database) of the Buddymatcher application. It was created using Spring Boot and uses H2 for its database system.
The run configuration should look like the image below. The API can be accessed at localhost:8080/api/
The app's login system is done through Sign In With Google, and hence this project's API is associated with a google account. For the credentials for this account, please refer to one of the original team members.
Details on the authentication flow and use of tokens can be found in the frontend wiki here.
Before creating a pull request, you should make sure your backend still passes all the tests with your changes. You can do this with Intellij by opening the Maven popup on the right side of the IDE and running "test" under Lifecycle. You don't need to have the app running before this step - the testing will take care of it.
If successful, the output should look like this:
Note, while all requests to endpoints are normally prehandled, this is bypassed in the endpoint tests so no need to worry about authentication.
If you would like to manually test the app, you can hit any endpoint you'd like using Postman or Swagger. To test the API this way, you will need to pass in a custom JWT in your request. See Authentication above for how it works.
Information about the backend project structure can be found here.