-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Some cleanup and adding more ressources for others
- Loading branch information
1 parent
6b45728
commit 5ccc2e4
Showing
7 changed files
with
712 additions
and
29 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,55 @@ | ||
# Pandemie-Inc | ||
![Pandemie Inc.](pandemieinc-logo.png "Pandemie Inc.") | ||
|
||
## Requirements | ||
- Java (version >= 8) | ||
Unser Beitrag zum [informatiCup 2020 - Pandemie!](https://github.com/informatiCup/informatiCup2020). | ||
|
||
> Der informatiCup 2020 widmet sich der Aufgabe, die Menschheit vor der Auslöschung durch eine Pandemie zu retten. | ||
Unsere Dokumentation und Präsentation befinden sich hier auch im Repository. | ||
Die Dokumentation zum Source-Code kann [hier](https://supernascher.github.io/Pandemie-Inc/) betrachetet werden | ||
oder mittels `mvn javadoc:javadoc` selbstständig erstellt werden. | ||
|
||
## Abhängigkeiten | ||
|
||
Folgende Abhängigkeiten werden für das Bauen unseres Projekts benötigt: | ||
|
||
- Java (Version >= 8) (fürs Kompilieren das JDK, bzw. OpenJDK) | ||
- Maven | ||
|
||
## Development | ||
Weitere Abhängigkeiten (Spring Boot, JUnit und ND4J) werden später von Maven verwaltet. | ||
|
||
Wir bieten auch ein Maven-Wrapper an, falls es nicht möglich ist Maven zu installieren. | ||
Alternativ bieten wir die Möglichkeit über Docker unsere Software zu benutzen. | ||
|
||
|
||
## Entwicklung | ||
|
||
1) `mvn spring-boot:run` | ||
|
||
Damit startet Maven Spring, nachdem es den geänderten Quellcode kompiliert hat. | ||
|
||
|
||
## Building for Release | ||
## Bauen der Software | ||
|
||
1) `mvn package` | ||
2) `java -jar target/pandemieinc-0.0.1-SNAPSHOT.jar` | ||
|
||
For cleaning: `mvn clean` | ||
Mit `mvn clean` wird das Repository aufgeräumt, also die kompilierten Dateien gelöscht. | ||
|
||
|
||
## Miscellaneous | ||
## Docker | ||
|
||
If you encounter a problem with your installed maven version, you can use `./mvnw` or `./mvnw.cmd` instead | ||
of `mvn`. | ||
Wir bieten auch ein **Dockerfile** an, womit ein "Image" gebaut werden kann, dass dann mittels [Docker](https://www.docker.com) | ||
gestartet und benutzt werden kann. | ||
|
||
- Bauen: `docker build -t tubs/pandemieinc .` | ||
- Starten: `docker run -p 8080:8080 tubs/pandemieinc` | ||
|
||
|
||
## Sonstiges | ||
|
||
Falls Probleme mit Maven auftreten sollte, wir bieten ein Maven-Wrapper an. | ||
Einfach `./mvnw` (Linux/Mac OS/BSD) oder `./mvnw.cmd` (Windows) benutzen, statt `mvn`. | ||
|
||
## Docker | ||
|
||
We have a `Dockerfile` file for building an image that can be used to run the application on [Docker](https://www.docker.com). | ||
- Build: `docker build -t tubs/pandemieinc .` | ||
- Run: `docker run -p 8080:8080 tubs/pandemieinc` | ||
Falls man beim Starten unserer Software keine IP-Adresse und Port angibt, ist | ||
unsere Websoftware unter `127.0.0.1:8080` oder `localhost:8080` erreichbar. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.