Erik/DataDash
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add deployment and part of usage

Browse Source
This commit is contained in:
Erik Foris
2024-07-08 16:17:36 +02:00
parent 6faa483bc0
commit 70c5a3077d
1 changed files with 40 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@@ -7,29 +7,58 @@ It provides the ability to Up-/ Down- vote entries, and to indicate the qulaity
## Features: ## Features:
## Installation: ## Installation:
### On Linux and Mac
To install DataDash, follow these steps: To install DataDash, follow these steps:
1. Clone the repository: 1. Clone the repository:
``` ```
git clone https://github.com/your-username/DataDash.git 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 plese refer to the Instalation instructions for your os
3. Start the application: 4. Start the application:
``` ```
./mvnw spring-boot:run ./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: ## Usage:
1. Open your web browser and navigate to `http://localhost:8080`. 1. Open your web browser and navigate to `http://localhost:8080`.
2. Click on the "Upload Data" button to import your data. 2. Some dummy data will be shown.
3. Select the desired chart type and customize it according to your preferences. 3. add your own Datasets and API's with via the add button in the top left corner
4. Explore and interact with the chart by using the provided controls. 4. If you want to browse all datasets, you can enter a ```%``` into the search bar #TODO: Update
5. Save and share your visualizations with others. 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.
## License: 3. You can also vote, just by hovering and clicking on the stars.
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. 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.