Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,30 @@ dashboard for monitoring and basic administration of tasks.

* An existing Spring Boot application, with [db-scheduler](https://github.com/kagkarlsson/db-scheduler)
* Minimum db-scheduler version 15
* Minimum Java 17 and SpringBoot 3.3
* Minimum Java 17 and SpringBoot 3.3 (or SpringBoot 4.0 for the Spring Boot 4 starter)
* Optional (if you want task history): db-scheduler-log version 0.7.0

## Getting started

1. Add the db-scheduler-ui spring boot starter maven dependency

```xml

<dependency>
<groupId>no.bekk.db-scheduler-ui</groupId>
<artifactId>db-scheduler-ui-starter</artifactId>
<version>4.3.0</version>
</dependency>
```
**For Spring Boot 3:**
```xml
<dependency>
<groupId>no.bekk.db-scheduler-ui</groupId>
<artifactId>db-scheduler-ui-starter</artifactId>
<version>4.6.0</version>
</dependency>
```

**For Spring Boot 4:**
```xml
<dependency>
<groupId>no.bekk.db-scheduler-ui</groupId>
<artifactId>db-scheduler-ui-spring-boot-4-starter</artifactId>
<version>4.6.0</version>
</dependency>
```

2. Read the [db-scheduler](https://github.com/kagkarlsson/db-scheduler) readme and follow the getting started guide. The
most important is to create the `scheduled_tasks` table correctly.
Expand Down Expand Up @@ -178,4 +187,4 @@ There are two ways to run the frontend locally.
2. running `mvn install` will build the frontend and copy the output to the resources folder in the `db-scheduler-ui`
module. The frontend will then be available at the same port as the example app.

To run the backend run `mvn clean install` and then run the example app.
To run the backend run `mvn clean install` and then run the example app.