README.md

java-caesar-cipher

Caesar Cipher

Motivation

• Encrypt and Decrypt texts using the caesar cipher pattern.

Before start

Make sure the prerequisite list below is present on your environment

• JAVA 8 (at least)
• Docker the latest stable version is recommended
• Maven
  • Follow the Baeldung tutorial to configure the environment variables properly

API Reference

Links below describes how the API endpoints are defined.

• encode
• decode

Running (localhost)

• In the application root, run mvn clean install in order to generate the proper binaries.

Once the above statement is completed, the target folder is now containing the jar file

• Still in the application root, run docker-compose up --build, and wait for the application deployment in docker.

By default, docker runs in localhost, anyhow check the docker host in docker configuration

Logs

Class Diagram