Added README.md and zip file
This commit is contained in:
parent
f9296fd4c8
commit
6e3167326d
BIN
Kontaktprojekt_20C_9829423.zip
Normal file
BIN
Kontaktprojekt_20C_9829423.zip
Normal file
Binary file not shown.
59
README.md
Normal file
59
README.md
Normal file
@ -0,0 +1,59 @@
|
|||||||
|
# Programmieren 2 – Contact-DB
|
||||||
|
|
||||||
|
## Compile
|
||||||
|
1. Compile project:
|
||||||
|
```shell
|
||||||
|
javac -sourcepath src -d build $(find src -path src/de/dhbw/unit -prune -false -o -name *.java)
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Copy resources:
|
||||||
|
```shell
|
||||||
|
mkdir build/de/dhbw/contactdb/db && cp src/de/dhbw/contactdb/db/contacts2021.db build/de/dhbw/contactdb/db/contacts2021.db
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
1. Tests by Johannes Unterstein
|
||||||
|
```shell
|
||||||
|
java -cp build/ de.dhbw.contactdb.ProjectTest.ProjektTester
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Unittests
|
||||||
|
Tests are included in de.dhbw.unit.ProjectTest
|
||||||
|
|
||||||
|
The easiest way to run them is by using IntelliJ or any other IDE.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
After compiling (and testing) you can use this tool. The available functions are listed below:
|
||||||
|
|
||||||
|
1. Search for persons:
|
||||||
|
```shell
|
||||||
|
> java -cp build/ de.dhbw.contactdb.Main --personensuche="Ila"
|
||||||
|
Mila Milan
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Search for places:
|
||||||
|
```shell
|
||||||
|
> java -cp build/ de.dhbw.contactdb.Main --ortssuche="Markt"
|
||||||
|
Supermarkt Großmarkt
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Find contact persons:
|
||||||
|
```shell
|
||||||
|
> java -cp build/ de.dhbw.contactdb.Main --kontaktpersonen=1
|
||||||
|
Aaron, Amelie, Ben, Emil, Emilia, Emily, Felix, Hannah, Hannes, Julius, Leonard, Levi, Louis, Malia, Marlene, Ole, Rosalie, Sophia, Victoria
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Find visitors:
|
||||||
|
```shell
|
||||||
|
> java -cp build/ de.dhbw.contactdb.Main --besucher=1,"2021-05-15T14:16:00"
|
||||||
|
Adam, Amelie, Carla, Carlotta, Charlotte, Elli, Emil, Emilia, Emily, Emma, Eva, Fiona, Hannah, Hannes, Jonah, Jonas, Joshua, Konstantin, Lian, Lisa, Luisa, Malia, Mara, Maria, Mattis, Max, Melina, Mia, Mohammed, Noah, Ole, Sophia, Tim, Tom, Toni, Victoria
|
||||||
|
```
|
||||||
|
|
||||||
|
## Docs
|
||||||
|
If you want to understand this code, you can use the UML diagram or the javadoc.
|
||||||
|
|
||||||
|
### Javadoc
|
||||||
|
Navigate into the `docs` directory and open `index.html` in your preferred browser.
|
||||||
|
|
||||||
|
### UML
|
||||||
|
The uml diagram is located in the `uml` directory. The `*.drawio` file can be shown or edited with [draw.io](https://draw.io).
|
@ -1 +1,2 @@
|
|||||||
|
#!/bin/bash
|
||||||
/home/florian/.jdks/openjdk-16.0.2/bin/javadoc -locale de -private -splitindex -use -author -version -exclude de.dhbw.contactdb.ProjectTest -d /home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/docs -classpath "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank:/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src:/home/florian/.m2/repository/org/junit/jupiter/junit-jupiter/5.7.0/junit-jupiter-5.7.0.jar:/home/florian/.m2/repository/org/junit/jupiter/junit-jupiter-api/5.7.0/junit-jupiter-api-5.7.0.jar:/home/florian/.m2/repository/org/apiguardian/apiguardian-api/1.1.0/apiguardian-api-1.1.0.jar:/home/florian/.m2/repository/org/opentest4j/opentest4j/1.2.0/opentest4j-1.2.0.jar:/home/florian/.m2/repository/org/junit/platform/junit-platform-commons/1.7.0/junit-platform-commons-1.7.0.jar:/home/florian/.m2/repository/org/junit/jupiter/junit-jupiter-params/5.7.0/junit-jupiter-params-5.7.0.jar:/home/florian/.m2/repository/org/junit/jupiter/junit-jupiter-engine/5.7.0/junit-jupiter-engine-5.7.0.jar:/home/florian/.m2/repository/org/junit/platform/junit-platform-engine/1.7.0/junit-platform-engine-1.7.0.jar" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/utils/Parser.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/Main.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/utils/db_new_entity.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/Place.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/unit/ProjectTest.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/Person.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/Visit.java"
|
/home/florian/.jdks/openjdk-16.0.2/bin/javadoc -locale de -private -splitindex -use -author -version -exclude de.dhbw.contactdb.ProjectTest -d /home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/docs -classpath "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank:/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src:/home/florian/.m2/repository/org/junit/jupiter/junit-jupiter/5.7.0/junit-jupiter-5.7.0.jar:/home/florian/.m2/repository/org/junit/jupiter/junit-jupiter-api/5.7.0/junit-jupiter-api-5.7.0.jar:/home/florian/.m2/repository/org/apiguardian/apiguardian-api/1.1.0/apiguardian-api-1.1.0.jar:/home/florian/.m2/repository/org/opentest4j/opentest4j/1.2.0/opentest4j-1.2.0.jar:/home/florian/.m2/repository/org/junit/platform/junit-platform-commons/1.7.0/junit-platform-commons-1.7.0.jar:/home/florian/.m2/repository/org/junit/jupiter/junit-jupiter-params/5.7.0/junit-jupiter-params-5.7.0.jar:/home/florian/.m2/repository/org/junit/jupiter/junit-jupiter-engine/5.7.0/junit-jupiter-engine-5.7.0.jar:/home/florian/.m2/repository/org/junit/platform/junit-platform-engine/1.7.0/junit-platform-engine-1.7.0.jar" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/utils/Parser.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/Main.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/utils/db_new_entity.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/Place.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/unit/ProjectTest.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/Person.java" "/home/florian/Dokumente/Programmieren/IntelliJIDEAProjects/Programmieren-2-Kontaktdatenbank/src/de/dhbw/contactdb/Visit.java"
|
2
create_zip.sh
Normal file
2
create_zip.sh
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
zip -r Kontaktprojekt_20C_9829423.zip docs/ src/ uml/ README.md
|
Loading…
Reference in New Issue
Block a user