EasyDrop/README.md

# EasyDrop

![Version](https://img.shields.io/badge/version-0.2.0-blue)
![Pipeline](https://gitlab.fbe-adswen.rwu.de/team1/sandbox2/badges/main/pipeline.svg)
[![Coverage](https://sonar.fbe-adswen.rwu.de/api/project_badges/measure?project=de.rwu%3Aeasydrop&metric=coverage&token=sqb_2fe80aed361468170aaef32a0ff96d596456cdd1)](https://sonar.fbe-adswen.rwu.de/dashboard?id=de.rwu%3Aeasydrop)
![JAMANN](https://img.shields.io/badge/Auszahlung-Letzte%20Woche-brightgreen)

## Description

Get rich quick™ with fully automated dropshipping!

## Visuals ✨

![Demo Image](Docs/DemoImage.png)

## Installation ⚙

As the application is still in development, development software will be required along its regular execution environment.

- JDK 17
- Maven
- _[More/context](https://gitlab.fbe-adswen.rwu.de/team1/sandbox2/-/wikis/Projektdokumentation/Development#software)_

## Usage 🛠

Set up the required configuration files, use the corresponding demo files for orientation.

- `config/config.properties` for API authorization
- `products-config.json` to define product catalogues to use for dropshipping

Run the following command to execute the program:

```sh
mvn compile exec:java -Dexec.mainClass="de.rwu.easydrop.Main"
```

## Roadmap 🏁

_Future ideas!_

## Contributing 👷‍♂️👷‍♀️

Contribution guidelines are available in the [project wiki](https://gitlab.fbe-adswen.rwu.de/team1/sandbox2/-/wikis/Richtlinien/Development)