chore: Update installation instructions

This commit is contained in:
Erik Foris 2024-07-08 16:52:11 +02:00
parent f58ee4a572
commit f6ad0a258e

View File

@ -1,21 +1,27 @@
# Project Name: DataDash
## Description:
## Description
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:
## Features
## Installation
## Installation:
### On Linux and Mac
To install DataDash, follow these steps:
1. Clone the repository:
```
```bash
git clone https://github.com/your-username/DataDash.git
```
2. Enter the repo
```
```bash
cd datadash
```
@ -23,20 +29,27 @@ cd datadash
plese refer to the Instalation instructions for your os
4. Start the application:
```
./mvnw spring-boot:run
```
additional requirements will be downloaded by and managed maven.
#### Deplyment
1. Clone the repository:
```bash
git clone https://github.com/your-username/DataDash.git
```
2. Enter the repo
```
cd datadash
```
3. Remove sample data(Optional)
remove the ```src/main/resources/data.sql``` to remove the sample data.
*Note:* This will also remove all default Categories.
@ -45,16 +58,20 @@ remove the ```src/main/resources/data.sql``` to remove the sample data.
plese refer to the Instalation instructions for your os
5. Start the application:
```bash
./mvnw package
```
this will create the ```.war``` file that you can deploy as you like
## Usage:
## Usage
1. Open your web browser and navigate to `http://localhost:8080`.
2. Some dummy data will be shown.
3. add your own Datasets and API's with via the add button in the top left corner
3. add your own Datasets and API's with via the add button in the top left corner
4. you can Search for datasets or browse by selecting how the entries shall be sorted under the ```⥮``` menu. You can also filter for Categories or type( e.g.Category or API)
5. For mor information on a certain dataset just click on it
5. For mor information on a certain dataset just click on it
1. You can differentiate between API and Dataset via the blue box.
2. The quality of is indicated by the stars on the lefthandside just below the title.
3. You can also vote, just by hovering and clicking on the stars.
@ -63,4 +80,4 @@ this will create the ```.war``` file that you can deploy as you like
6. In the Next section some Stats regarding the date of submission, Category, License and the Terms of use are shown
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.
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.