Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Gerrit Alexander Simon Evers
Verteilte Systeme Projekt
Commits
9c8ebc80
Commit
9c8ebc80
authored
Feb 09, 2021
by
Andre Blanke
Browse files
Add prerequisites section to README.md
parent
87c3017c
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
9c8ebc80
...
...
@@ -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.
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment