Project Name: DataDash

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.

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

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:

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.

4. Install Java 22-jdk: Please refer to the Installation instructions for your os

5. 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. 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.

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