Commit 9c8ebc80 authored by Andre Blanke's avatar Andre Blanke
Browse files

Add prerequisites section to README.md

parent 87c3017c
......@@ -3,6 +3,7 @@
## Table of contents
- [Project structure](#project-structure)
- [Prerequisites](#prerequisites)
- [Overview](#overview)
- [Deployment](#deployment)
- [Getting started](#getting-started)
......@@ -53,6 +54,18 @@
└─ Vagrantfile # Virtual machine configurations
```
## Prerequisites
- Vagrant, to run the virtual machines
### Optional dependencies
- JDK 15, to compile the backend code outside of a provisioned virtual machine. Higher versions
should be fine as well but are not released at the time of writing
- Maven, to package the frontend and backend parts into a JAR. The provided Maven wrapper `mvnw`
may be used instead
- CockroachDB, if one wants to run the packaged JAR outside of a provisioned virtual machine
## Overview
This project realizes a basic URL shortener using Spring on the backend and Angular on the frontend.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment