README.md

Social network Spring REST API (Java 17)

Build status

Master	Develop

Description

• API Base endpoint: localhost:8080/api
• Swagger: localhost:8080/api/swagger-ui.html
• H2 console: localhost:8080/api/h2-console

Prerequisites

• JDK 17
• Maven

How to run (CLI)

Make sure you have all prerequisites, no Maven wrapper is included.

1. Clone/download the repository.

2. Open the project folder in a terminal.

3. Run the app:

mvn spring-boot:run

Built with

• Spring - Jakarta EE Framework
• Spring Data JPA - Spring JPA framework
• Spring Security - Spring security framework
• H2 Database - for development purposes
• Project Lombok - used to reduce boilerplate code
• Springdoc OpenAPI - used for generating API docs
• JJWT - used for creating and verifying JWTs
• ModelMapper - model mapping library

License

This application is open-sourced software licensed under the MIT license.