This repo to be used as a template for a gitdate application backend
Use the Gitdate Frontend Template with this template to have register, login, view profile, connect, and view matches functionality working right out of the box!
This template is built with Spring Boot. It uses Hibernate and Spring Data for data access operations. It has an AOP configuration for logging all repository, service, and controller method calls.
This project took inspiration (and a lot of code!) from the following repositories:
- Spring Security with Github Oauth
- Most of the application architecture taken from this repo
- Microservice Framework for AOP Monitoring
- The com.example.springsocial.monitoring package was based on the com.ibm.dip.microsvcengineering.framework.monitoring package in this repo
- Create a github oauth application
- Copy the client id and client secret
- Update application.yml with your id and secret
- Generate an application secret for your application
- Update application.yml with your app's secret
- Update your datasource properties. If you want to use the current properties, you must create a postgres database instance with name socialtesta and postgres as username/password
This template has 5 primary functions:
- Register
- Login
- View Profile
- Connect - like or dislike other users
- View Matches
You can run on localhost as you would with run any Spring Boot Application, using a local database.
You can inspect the api documentation using Swagger. To do this you must:
-
Run the application using the previous steps
-
navigate to http://localhost:8080/swagger-ui.html#/