From 6faa483bc07820da7471f987084720cc27b7ec03 Mon Sep 17 00:00:00 2001 From: Erik Foris Date: Sat, 6 Jul 2024 21:55:24 +0200 Subject: [PATCH 1/8] chore: add preliminary documentation --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index e69de29..fcf89b0 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,35 @@ +# Project Name: DataDash + +## 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: + +## Installation: +To install DataDash, follow these steps: + +1. Clone the repository: +``` +git clone https://github.com/your-username/DataDash.git +``` + +2. Install Java 22-jdk: +plese refer to the Instalation instructions for your os + +3. Start the application: +``` +./mvnw spring-boot:run +``` +additional requirements will be downloaded by maven. + +## Usage: +1. Open your web browser and navigate to `http://localhost:8080`. +2. Click on the "Upload Data" button to import your data. +3. Select the desired chart type and customize it according to your preferences. +4. Explore and interact with the chart by using the provided controls. +5. Save and share your visualizations with others. + + +## License: +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. \ No newline at end of file From 70c5a3077d2f907565c9cdf3fa3116485ccae631 Mon Sep 17 00:00:00 2001 From: Erik Foris Date: Mon, 8 Jul 2024 16:17:36 +0200 Subject: [PATCH 2/8] add deployment and part of usage --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 40 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fcf89b0..d7cf71c 100644 --- a/README.md +++ b/README.md @@ -7,29 +7,58 @@ It provides the ability to Up-/ Down- vote entries, and to indicate the qulaity ## Features: ## Installation: +### On Linux and Mac To install DataDash, follow these steps: 1. Clone the repository: ``` git clone https://github.com/your-username/DataDash.git ``` +2. Enter the repo +``` +cd datadash +``` -2. Install Java 22-jdk: +3. Install Java 22-jdk: plese refer to the Instalation instructions for your os -3. Start the application: +4. Start the application: ``` ./mvnw spring-boot:run ``` -additional requirements will be downloaded by maven. +additional requirements will be downloaded by and managed maven. +#### Deplyment +1. Clone the repository: +``` +git clone https://github.com/your-username/DataDash.git +``` +2. Enter the repo +``` +cd datadash +``` + +3. Install Java 22-jdk: +plese refer to the Instalation instructions for your os + +4. Start the application: +``` +./mvnw package +``` +this will create the ```.war``` file that you can deploy as you like ## Usage: 1. Open your web browser and navigate to `http://localhost:8080`. -2. Click on the "Upload Data" button to import your data. -3. Select the desired chart type and customize it according to your preferences. -4. Explore and interact with the chart by using the provided controls. -5. Save and share your visualizations with others. - - -## License: -This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. \ No newline at end of file +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 +4. If you want to browse all datasets, you can enter a ```%``` into the search bar #TODO: Update +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. + 4. To the left of the stars the summary is displayed + 5. Below the stars the the source of the Dataset/API is linked + 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. +6. \ No newline at end of file From 09a5e526cd872264191c26daded4769c7131e993 Mon Sep 17 00:00:00 2001 From: Erik Foris Date: Mon, 8 Jul 2024 16:33:40 +0200 Subject: [PATCH 3/8] finish usage section --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d7cf71c..f3fbc60 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ this will create the ```.war``` file that you can deploy as you like 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 -4. If you want to browse all datasets, you can enter a ```%``` into the search bar #TODO: Update +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 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. @@ -60,5 +60,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. -6. \ No newline at end of file + 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. \ No newline at end of file From f58ee4a57201389999e1377a513b2bd8c58c0cb5 Mon Sep 17 00:00:00 2001 From: Erik Foris Date: Mon, 8 Jul 2024 16:46:37 +0200 Subject: [PATCH 4/8] add explanation to remove sample data --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f3fbc60..a67b3fb 100644 --- a/README.md +++ b/README.md @@ -30,19 +30,22 @@ 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. -3. Install Java 22-jdk: +4. Install Java 22-jdk: plese refer to the Instalation instructions for your os -4. Start the application: -``` +5. Start the application: +```bash ./mvnw package ``` this will create the ```.war``` file that you can deploy as you like From f6ad0a258ee22f35a1b9ef140cf127badd285e65 Mon Sep 17 00:00:00 2001 From: Erik Foris Date: Mon, 8 Jul 2024 16:52:11 +0200 Subject: [PATCH 5/8] chore: Update installation instructions --- README.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a67b3fb..ec710cb 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file + 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. From d70d94d1b906ad2a766a9010bf9f688f25738d2a Mon Sep 17 00:00:00 2001 From: Erik Foris Date: Mon, 8 Jul 2024 19:50:03 +0200 Subject: [PATCH 6/8] complete readme --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ec710cb..2abe14f 100644 --- a/README.md +++ b/README.md @@ -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 From db4778d0f7bd939e90e50fbc7a60306e8f417863 Mon Sep 17 00:00:00 2001 From: Erik Foris Date: Mon, 8 Jul 2024 19:51:14 +0200 Subject: [PATCH 7/8] fix typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2abe14f..38de0e3 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ ## 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. +DataDash is a simple product hunt like "Tool" for searching and discovering the newest Datasets and API's. +It provides the ability to Up-/ Down- vote entries, and to indicate the quality of a given Dataset/API by giving up to 5 starts. ## Installation @@ -53,7 +53,7 @@ remove the ```src/main/resources/data.sql``` to remove the sample data. *Note:* This will also remove all default Categories. 4. Install Java 22-jdk: -plese refer to the Instalation instructions for your os +Please refer to the Installation instructions for your os 5. Start the application: From 8cb0f2f48ace5320bcf450b7ad62bd971c0a2339 Mon Sep 17 00:00:00 2001 From: Elias Schriefer Date: Mon, 8 Jul 2024 23:15:23 +0200 Subject: [PATCH 8/8] Improve README --- README.md | 119 +++++++++++++++++++++++++----------------------------- 1 file changed, 56 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 38de0e3..bd34c62 100644 --- a/README.md +++ b/README.md @@ -1,95 +1,88 @@ -# Project Name: DataDash +# DataDash – Explore public APIs and datasets + +[TOC] ## Description - -DataDash is a simple product hunt like "Tool" for searching and discovering the newest Datasets and API's. -It provides the ability to Up-/ Down- vote entries, and to indicate the quality of a given Dataset/API by giving up to 5 starts. +DataDash is a simple Product Hunt-like "tool" for searching and discovering the newest datasets and APIs. +It provides the ability to up-/downvote entries, and to indicate the quality of a given dataset/API by rating it on a scale of 0 to 5 stars. ## Installation - ### On Linux and Mac - To install DataDash, follow these steps: -1. Clone the repository: - +#### 1. Clone the repository: ```bash -git clone https://github.com/your-username/DataDash.git +$ git clone https://git.fim.uni-passau.de/padas/24ss-5430-web-and-data-eng/gruppe-3/datadash.git ``` -2. Enter the repo - +#### 2. Enter the repo: ```bash -cd datadash +$ cd datadash ``` -3. Install Java 22-jdk: -Please refer to the Installation instructions for your os - -4. Start the application: - -``` -./mvnw spring-boot:run -``` - -additional requirements will be downloaded by and managed maven. - -#### Deployment - -1. Clone the repository: +#### 3. Install Java JDK 22: Please refer to the installation instructions for your package manager/OS. +#### 4. Start the application: ```bash -git clone https://github.com/your-username/DataDash.git +$ ./mvnw spring-boot:run ``` -2. Enter the repo +Additional dependencies will be downloaded and managed by maven. -``` -cd datadash -``` +## Deployment +### 1. Follow [installation steps 1-3](#installation). -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. +### 2. _(Optional)_ Remove sample data: +Remove [`src/main/resources/data.sql`](src/main/resources/data.sql) to remove the sample data. -4. Install Java 22-jdk: -Please refer to the Installation instructions for your os - -5. Start the application: +> **Note:** This will also remove all default categories. +### 3. Package the application: ```bash -./mvnw package +$ ./mvnw package ``` -this will create the ```.war``` file that you can deploy as you like +This will create the `.war` file that you can deploy as you like. ## 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 -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 - 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. - 4. To the left of the stars the summary is displayed - 5. Below the stars the the source of the Dataset/API is linked - 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. + +2. Some **dummy data** will be shown (if configured, see [deployment step 2](#2-optional-remove-sample-data)). + +3. Add your own datasets and APIs via the **add button** in the top left corner. + +4. In the top right you can see the **search toolbar**. Here you can **sort**, input **search terms**, and **filter by categories or type of content** (i.e. dataset or API). + +5. For **more information** on a certain dataset just click on it + + 1. You can differentiate between **API** and **dataset** via the **blue box**. + + 2. The **user perceived quality** is indicated by the **number and stars** on the left hand side just below the title. + + 3. You can also **vote** by just **hovering** and then **clicking on the stars**. + + 4. Right next to the stars the **summary** is displayed. It's a short text describing the main purpose. + + 5. Below the star rating and summary the **dataset's/API's source** is linked + + 6. In the next section some metadata regarding the **date of submission**, **category**, **license** and a link to the **Terms of Use** are shown. + + 7. Next you can see a **full description**. + + 8. At the very bottom of the page there is a 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 **your browser's back button**. + + 9. If you created the entry that you are currently looking at, you will find a **`Delete`** button next to the `Back to main page` button. This will **delete** the entry **without any further confirmation**. ## Used Frameworks/Libraries - ### Frontend +None, our whole frontend is written in **native HTML, CSS, and JavaScript**. -None, our whole frontend is written in native javaScript, HTML and CSS. +It has been tested on **Firefox 127** and **Chromium 126**. -## Backend - -- spring-boot-starter-web -- springdoc-openapi-starter-webmvc-ui< -- spring-boot-starter-tomcat -- spring-boot-starter-test -- com.h2database +### Backend +We have used the following dependencies: + - `spring-boot-starter-web` + - `springdoc-openapi-starter-webmvc-ui` + - `spring-boot-starter-tomcat` + - `spring-boot-starter-test` + - `com.h2database`