README.md

Stumpy

A URL Shortener Application.

Objective

The main objective of this project; build a complete application with various technologies and approaches.

Tech

Stumpy developed with Java 8, a number of technologies and open source projects:

• SpringBoot
• Redis
• Docker
• Maven
• JUnit
• Swagger
• Asciidoctor
• Swagger2Markup
• Apache Maven Checkstyle Plugin

For Developers

To avoid build failures you must import these files (eclipse-code-formatter.xml, eclipse.importorder) to your IDE. The files are under the codequality folder.

Installation

Stumpy requires JDK8. Please check your JAVA_HOME for success of build.

$ echo ${JAVA_HOME}

This is a maven project. Before the Docker initialization please run maven install command.

$ cd ${project.basedir}
$ mvn clean install

Documentation

After building the project. You can check out the documentation of project html file at this path.

file://${project.basedir}/target/generated-docs/html/en/index.html

Docker

For log volume please create stumpy-service-log-repo

$ docker volume create --name=stumpy-service-log-repo

Composing containers. This command requires active internet connection for download cekinmezyucel:alpine-java8 and redis:alpine images.

$ cd ${project.basedir}/docker/
$ docker-compose up --build