Quake Log Parser

It's a project to parse some statistics from quake 3 arena game and show them.

Getting Started

To begin using this project, choose one of the following options to get started:

• Download the latest release
• Clone the repo: git clone https://github.com/marcosouza93/quake-log-parser.git
• Fork the repo

Requirements

JDK 1.8
Apache Maven
Docker

Installing with Docker

Execute the following command to generate a jar file of the project:

mvn clean install

Use the container plataform docker to start the project. Execute the following command on the source folder to generate an image from the project:

docker build -t labs/quake-log-parser .

And this commmand to start the project inside of a docker container (exposing the port number 8080):

docker run -d -p 8080:8080 labs/quake-log-parser:latest

Installing without Docker

Execute the following command to generate a jar file of the project:

mvn clean install

Execute the following command to start the project:

java -jar -Dspring.profiles.active=default target/quake-log-parser-0.0.1-SNAPSHOT.jar

Executing

It was used spring actuator to expose some service information, to access it use the following URL's:

http://localhost:8080/actuator/info
http://localhost:8080/actuator/health

To call the endpoint with the parser service, use the following URL from Swagger:

http://localhost:8080/swagger-ui.html

Or access directly the endpoint on a browser through the following URL:

http://localhost:8080/api/report

Executing with Heroku (Application deployed in the cloud)

It was built a pipeline to deploy this project in Heroku Cloud Application Plataform, to access it through Swagger, use the following URL:

https://the-quake-log-parser.herokuapp.com/swagger-ui.html

Or access directly the endpoint on a browser through the following URL:

https://the-quake-log-parser.herokuapp.com/api/report

Running the tests

This project includes jacoco dependency, so it's possible to get information about the project coverage using the following command:

mvn clean test

At the final will be generated a report on the path "target/site/jacoco/index.html" like this one:

Built With

• Java 8 - High-level Programming Language
• Spring Boot - Web Framework
• Maven - Dependency Management
• Jacoco - Java Code Coverage Library
• Swagger - Java Webpack
• Docker - Enterprise Container Platform
• Lombok - Java Library
• Heroku - Cloud Application Platform

Author

• Marco Souza - marcosouza93