chore: Update installation instructions

This commit is contained in:
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,11 +58,15 @@ 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