Skip to content

Commit

Permalink
build: release version 1.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
timefold-release authored and triceo committed Mar 12, 2024
1 parent 2e23741 commit 0cd7cab
Show file tree
Hide file tree
Showing 199 changed files with 2,724 additions and 8,743 deletions.
5 changes: 3 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
version: 2
updates:
- package-ecosystem: maven
target-branch: "development"
directory: "/"
schedule:
interval: daily
time: '05:00'
open-pull-requests-limit: 10
target-branch: "development"
commit-message:
prefix: "deps: "
- package-ecosystem: gradle
target-branch: "development"
directory: "/"
schedule:
interval: daily
time: '06:00'
open-pull-requests-limit: 10
target-branch: "development"
commit-message:
prefix: "deps: "
- package-ecosystem: "github-actions"
target-branch: "development"
directory: "/"
schedule:
interval: "daily"
Expand Down
132 changes: 33 additions & 99 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,149 +8,83 @@ https://timefold.ai[timefold.ai]
|===
|Use case quickstarts |Technology quickstarts

a|* <<school-timetabling, School timetabling>>
* <<facility-location, Facility location problem>>
a|* <<vehicle-routing, Vehicle Routing>>
* <<maintenance-scheduling, Maintenance scheduling>>
* <<call-center, Call center>>
* <<vaccination-scheduling, Vaccination scheduling>>
* <<order-picking, Order Picking>>
* <<employee-scheduling, Employee Scheduling>>
* <<food-packaging, Food packaging>>
* <<vehicle-routing, Vehicle Routing>>
* <<order-picking, Order Picking>>
* <<school-timetabling, School timetabling>>
* <<facility-location, Facility location problem>>

a|* link:use-cases/school-timetabling/README.adoc[Quarkus] (Java, Maven or Gradle, Quarkus)
a|* link:hello-world/README.adoc[Java (Hello World)] (Java, Maven or Gradle)
* link:use-cases/school-timetabling/README.adoc[Quarkus] (Java, Maven or Gradle, Quarkus)
* link:technology/java-spring-boot/README.adoc[Spring Boot] (Java, Maven or Gradle, Spring Boot)
* link:technology/kotlin-quarkus/README.adoc[Kotlin] (Kotlin, Maven, Quarkus)

2+a|* <<timefold-solver-examples, Timefold examples (desktop)>>
|===

== Get started

Run the https://timefold.ai[Timefold] quickstarts now:

. Install JDK 17 or later with `JAVA_HOME` configured appropriately.
For example with https://sdkman.io[Sdkman]:
+
[source, shell]
----
$ curl -s "https://get.sdkman.io" | bash
$ sdk install java
----

. Clone this repository to build and run the quickstarts showcase:
+
[source, shell]
----
$ git clone https://github.com/TimefoldAI/timefold-quickstarts.git
$ cd timefold-quickstarts
$ ./runQuickstartsFromSource.sh
----

== Use cases

=== School timetabling

Assign lessons to timeslots and rooms to produce a better schedule for teachers and students.

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-school-timetabling-screenshot.png[]

* link:use-cases/school-timetabling/README.adoc[Run quarkus-school-timetabling] (Java, Maven or Gradle, Quarkus)
* link:technology/java-spring-boot/README.adoc[Run spring-boot-school-timetabling] (Java, Maven or Gradle, Spring Boot)
* link:technology/kotlin-quarkus/README.adoc[Run kotlin-quarkus-school-timetabling] (Kotlin, Maven, Quarkus)

Without a UI:

* link:hello-world/README.adoc[Run hello-world-school-timetabling] (Java, Maven or Gradle)

=== Facility location problem
=== Vehicle Routing

Pick the best geographical locations for new stores, distribution centers, covid test centers or telco masts.
Find the most efficient routes for vehicles to reach visits, taking into account vehicle capacity and time windows when visits are available. Sometimes also called "CVRPTW".

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-facility-location-screenshot.png[]
image::use-cases/vehicle-routing/quarkus-vehicle-routing-screenshot.png[]

* link:use-cases/facility-location/README.adoc[Run quarkus-facility-location] (Java, Maven, Quarkus)
* link:use-cases/vehicle-routing/README.adoc[Run quarkus-vehicle-routing] (Java, Maven, Quarkus)

=== Maintenance scheduling

Schedule maintenance jobs to crews over time to reduce both premature and overdue maintenance.

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-maintenance-scheduling-screenshot.png[]
image::use-cases/maintenance-scheduling/quarkus-maintenance-scheduling-screenshot.png[]

* link:use-cases/maintenance-scheduling/README.adoc[Run quarkus-maintenance-scheduling] (Java, Maven, Quarkus, H2)
* link:use-cases/maintenance-scheduling/README.adoc[Run quarkus-maintenance-scheduling] (Java, Maven, Quarkus)

=== Call center
=== Employee Scheduling

Schedule incoming calls to employees matching skills and availability.
Schedule shifts to employees, accounting for employee availability and shift skill requirements.

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-call-center-screenshot.png[]
image::use-cases/employee-scheduling/quarkus-employee-scheduling-screenshot.png[]

* link:use-cases/call-center/README.adoc[Run quarkus-call-center] (Java, Maven, Quarkus)
* link:use-cases/employee-scheduling/README.adoc[Run quarkus-employee-scheduling] (Java, Maven, Quarkus)

=== Vaccination scheduling
=== Food Packaging

Assign people to vaccination injection appointments over time at vaccination centers to end a pandemic sooner.
Schedule food packaging orders to manufacturing lines, to minimize downtime and fulfill all orders in time.

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-vaccination-scheduling-screenshot.png[]
image::use-cases/food-packaging/quarkus-food-packaging-screenshot.png[]

* link:use-cases/vaccination-scheduling/README.adoc[Run quarkus-vaccination-scheduling] (Java, Maven, Quarkus)
* link:use-cases/food-packaging/README.adoc[Run quarkus-food-packaging] (Java, Maven, Quarkus)

=== Order Picking

Generate an optimal picking plan for completing a set of orders.

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-order-picking-screenshot.png[]
image::use-cases/order-picking/quarkus-order-picking-screenshot.png[]

* link:use-cases/order-picking/README.adoc[Run quarkus-order-picking] (Java, Maven, Quarkus)

=== Employee Scheduling

Schedule shifts to employees, accounting for employee availability and shift skill requirements.

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-employee-scheduling-screenshot.png[]

* link:use-cases/employee-scheduling/README.adoc[Run quarkus-employee-scheduling] (Java, Maven, Quarkus, H2)

=== Food Packaging

Schedule food packaging orders to manufacturing lines, to minimize downtime and fulfill all orders in time.

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-food-packaging-screenshot.png[]

* link:use-cases/food-packaging/README.adoc[Run quarkus-food-packaging] (Java, Maven, Quarkus)

=== Vehicle Routing
=== School timetabling

Find the most efficient routes for vehicles to reach visits, taking into account vehicle capacity and time windows when visits are available. Sometimes also called "CVRPTW".
Assign lessons to timeslots and rooms to produce a better schedule for teachers and students.

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-vehicle-routing-screenshot.png[]
image::use-cases/school-timetabling/quarkus-school-timetabling-screenshot.png[]

* link:use-cases/vehicle-routing/README.adoc[Run quarkus-vehicle-routing] (Java, Maven, Quarkus)
* link:use-cases/school-timetabling/README.adoc[Run quarkus-school-timetabling] (Java, Maven or Gradle, Quarkus)
* link:technology/java-spring-boot/README.adoc[Run spring-boot-school-timetabling] (Java, Maven or Gradle, Spring Boot)
* link:technology/kotlin-quarkus/README.adoc[Run kotlin-quarkus-school-timetabling] (Kotlin, Maven, Quarkus)

=== Timefold examples (desktop)
Without a UI:

Many examples in desktop technology.
* link:hello-world/README.adoc[Run hello-world-school-timetabling] (Java, Maven or Gradle)

image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/timefold-solver-examples-screenshot.png[]
=== Facility location problem

[[run]]
==== Run the application
Pick the best geographical locations for new stores, distribution centers, covid test centers or telco masts.

. Git clone the timefold-solver repo and navigate to this directory:
+
[source, shell]
----
$ git clone https://github.com/TimefoldAI/timefold-solver.git
...
$ cd timefold-solver/examples
----
image::use-cases/facility-location/quarkus-facility-location-screenshot.png[]

. Start the application with Maven:
+
[source, shell]
----
$ mvn exec:java
----
* link:use-cases/facility-location/README.adoc[Run quarkus-facility-location] (Java, Maven, Quarkus)

== Legal notice

Expand Down
1 change: 0 additions & 1 deletion build/.mvn/maven.config

This file was deleted.

Binary file removed build/.mvn/wrapper/maven-wrapper.jar
Binary file not shown.
2 changes: 0 additions & 2 deletions build/.mvn/wrapper/maven-wrapper.properties

This file was deleted.

Loading

0 comments on commit 0cd7cab

Please sign in to comment.