chore: add preliminary documentation

This commit is contained in:
Erik Foris 2024-07-06 21:55:24 +02:00
parent cf1babf069
commit 6faa483bc0

View File

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