petivagyok16 / robotrade-api

RoboTrade-API

Description

This API is the link between RoboTrade stock trader service and its clients.

Used technologies, libraries & languages

• Java 1.8
• Spring boot
• maven package manager
• Spring Webflux (reactive, non-blocking framework)
• jsonwebtoken
• Project lombok
• Advanced Message Queuing Protocol by RabbitMQ
• CircleCI + Heroku CI/CD

How to install and run the project

• If using local development environment, mock-trader app has to be in the same folder as robotrade-api
• import root folder as a project to IntelliJ
• install maven dependencies
• install Lombok plugin inside IntelliJ (preferences/plugins/browse plugins)
• 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

Architecture