petivagyok16 / friendlytalks-api

friendlytalks-api

Description

This API is the complete re-write of Friendlytalks Node.js API in Java + Spring 5

How to install and run the project

• import root folder as a project to IntelliJ
• install maven dependencies
• install Lombok plugin inside IntelliJ (preferences/plugins/browse plugins)
• Run a MongoDB container using Docker: docker run -p 27071:27017 -d mongo
• Use your favorite mongo client to visit mongoDB e.g. Robo 3T
• If you are experiencing issues during the startup consider to click File/Invalidate Caches/restart in IntelliJ and/or inside Preferences/Settings -> Build/Execution, Deployment -> Compiler -> Annotation Processors click Enable annotation processing

How to use

• Open Postman, call auth/signin endpoint with valid credentials e.g. username: test, password: test and save the token to the environment variables in postman as tokenwhich is generated by the server
• Check the API documentation below for better overview
• API Documentation

Requirements

• JDK 1.8
• IntelliJ or Eclipse
• Project language level 8 - Lambdas, type annotations etc.
• Target bytecode version: 1.8