folley / JAlgoArena-API

API Gateway Service for backend services of JAlgoArena

Home Page:https://jalgoarena-ui.herokuapp.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

JAlgoArena API Build Status GitHub release

JAlgoArena API is API Gateway service for all backend JAlgoArena services. It's created based on Netflix Zuul with usage of Spring Boot and Spring Cloud.

Introduction

  • API Gateway is the single point forwarding to destination service. It's using Eureka for identifying url/addresses of the services just based on their names. Additionally - it has configured client load balancer (Netflix Ribbon) - which load balance requests - it's mainly used in JAlgoArena for many Judge Agents - as they are stateless services and considerably slowest part of JAlgoArena infrastructure.

Component Diagram

Components

Continuous Delivery

  • initially, developer push his changes to GitHub
  • in next stage, GitHub notifies Travis CI about changes
  • Travis CI runs whole continuous integration flow, running compilation, tests and generating reports
  • application is deployed into Heroku machine

Infrastructure

Running locally

There are two ways to run it - from sources or from binaries.

  • Default port: 5001

Running from binaries

  • go to releases page and download last app package (JAlgoArena-API-[version_number].zip)
  • after unpacking it, go to folder and run ./run.sh (to make it runnable, invoke command chmod +x run.sh)
  • you can modify port and Eureka service url in run.sh script, depending on your infrastructure settings. The script itself can be found in here: run.sh

Running from sources

  • run git clone https://github.com/spolnik/JAlgoArena-API to clone locally the sources
  • now, you can build project with command ./gradlew clean bootRepackage which will create runnable jar package with app sources. Next, run java -Dserver.port=5001 -jar build\libs\jalgoarena-api-*.jar which will start application
  • there is second way to run app with gradle. Instead of running above, you can just run ./gradlew clean bootRun

Notes

Component Diagram

About

API Gateway Service for backend services of JAlgoArena

https://jalgoarena-ui.herokuapp.com

License:Apache License 2.0


Languages

Language:Kotlin 96.0%Language:Shell 4.0%