Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 2.11 KB

PREREQS.MD

File metadata and controls

61 lines (36 loc) · 2.11 KB

Prerequisites

Git

You will need Git to clone this repository. Follow the getting started guide to complete your installation.

Java 21

You can install Java 21 however you'd like, but SDKMAN is a tool that makes installing and switching between versions a breeze.

  1. Install SDKMAN!
    • Tip: Add source "$HOME/.sdkman/bin/sdkman-init.sh" to your bash config file so that the source command is run each time the terminal starts up.
  2. Install Java 21 via SDKMAN!
    sdk install java 21.0.5-zulu
    sdk use java 21.0.5-zulu

Docker

To run any of the local docker clusters, you must first install and start Docker.

https://docs.docker.com/get-docker/

IDE

Only required if you're doing development on data-demo

IntelliJ CE is recommended, but use what you're comfortable with.

Project SDK Configuration

Only required if you're doing development on data-demo

Once you've opened the project in your IDE of choice, ensure the SDK is aligned with your Java 21 installation.

project-sdk

Enable Annotation Processors for Lombok

Only required if you're doing development on data-demo

Lombok is a tool that helps remove boilerplate in Java applications. Lombok is utilized in this project, so you must enabled annotation processors for Lombok to work.

enable-annotation-processing

Lombok Docs

jq (optional)

jq is a command line tool that can format (and do many other things) JSON responses. It is really only needed if you plan to run the mockdata-api and call the API via curl.

# example usage of jq 
curl -X POST localhost:8080/customers | jq

https://stedolan.github.io/jq/download/