complete readme

This commit is contained in:
Erik Foris 2024-07-08 19:50:03 +02:00
parent f6ad0a258e
commit d70d94d1b9

View File

@ -5,8 +5,6 @@
DataDash is a simple product hunt like "Tool" for searching and descovering the newest Datasets and API's.
It provides the ability to Up-/ Down- vote entries, and to indicate the qulaity of a given Dataset/API by giving up to 5 starts.
## Features
## Installation
### On Linux and Mac
@ -26,7 +24,7 @@ cd datadash
```
3. Install Java 22-jdk:
plese refer to the Instalation instructions for your os
Please refer to the Installation instructions for your os
4. Start the application:
@ -36,7 +34,7 @@ plese refer to the Instalation instructions for your os
additional requirements will be downloaded by and managed maven.
#### Deplyment
#### Deployment
1. Clone the repository:
@ -81,3 +79,17 @@ this will create the ```.war``` file that you can deploy as you like
7. Next you can see A longer description.
8. At the very bottom of the Page there is the button that will bring you back to the homepage. If you want to go back to the Previous page (e.g. Search) you might want to use the back button of your browser.
9. If you created the entry that you are looking at you will find that next to the ```back to main page``` button you will find a ```Delete``` button. This will delete the entry without asking asking if you are sure.
## Used Frameworks/Libraries
### Frontend
None, our whole frontend is written in native javaScript, HTML and CSS.
## Backend
- spring-boot-starter-web
- springdoc-openapi-starter-webmvc-ui<
- spring-boot-starter-tomcat
- spring-boot-starter-test
- com.h2database