Timefold Quickstarts

Planning optimization made easy.
timefold.ai

Overview of all Quickstarts

Use case quickstarts	Technology quickstarts
School timetabling Facility location problem Maintenance scheduling Call center Vaccination scheduling Order Picking Employee Scheduling Food packaging Vehicle Routing	Quarkus (Java, Maven or Gradle, Quarkus) Spring Boot (Java, Maven or Gradle, Spring Boot) Kotlin (Kotlin, Maven, Quarkus)
Timefold examples (desktop)

Get started

Run the Timefold quickstarts now:

1. Install JDK 17 or later with JAVA_HOME configured appropriately. For example with Sdkman:

   $ curl -s "https://get.sdkman.io" | bash
   $ sdk install java

2. Clone this repository to build and run the quickstarts showcase:

   $ 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.

• Run quarkus-school-timetabling (Java, Maven or Gradle, Quarkus)

• Run spring-boot-school-timetabling (Java, Maven or Gradle, Spring Boot)

• Run kotlin-quarkus-school-timetabling (Kotlin, Maven, Quarkus)

Without a UI:

• Run hello-world-school-timetabling (Java, Maven or Gradle)

Facility location problem

Pick the best geographical locations for new stores, distribution centers, covid test centers or telco masts.

• Run quarkus-facility-location (Java, Maven, Quarkus)

Maintenance scheduling

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

• Run quarkus-maintenance-scheduling (Java, Maven, Quarkus, H2)

Call center

Schedule incoming calls to employees matching skills and availability.

• Run quarkus-call-center (Java, Maven, Quarkus)

Vaccination scheduling

Assign people to vaccination injection appointments over time at vaccination centers to end a pandemic sooner.

• Run quarkus-vaccination-scheduling (Java, Maven, Quarkus)

Order Picking

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

• Run quarkus-order-picking (Java, Maven, Quarkus)

Employee Scheduling

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

• 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.

• Run quarkus-food-packaging (Java, Maven, Quarkus)

Vehicle Routing

Find the most efficient routes for vehicles to reach customers, taking into account vehicle capacity and time windows when customers are available. Sometimes also called "CVRPTW".

• Run quarkus-vehicle-routing (Java, Maven, Quarkus)

Timefold examples (desktop)

Many examples in desktop technology.

Run the application

1. Git clone the timefold-solver repo and navigate to this directory:

   $ git clone https://github.com/TimefoldAI/timefold-solver.git
   ...
   $ cd timefold-solver/examples

2. Start the application with Maven:

   $ mvn exec:java

Legal notice

Timefold Quickstarts was forked on 20 April 2023 from OptaPlanner Quickstarts, which was entirely Apache-2.0 licensed (a permissive license).

Timefold Quickstarts is a derivative work of OptaPlanner Quickstarts, which includes copyrights of the original creator, Red Hat Inc., affiliates and contributors, that were all entirely licensed under the Apache-2.0 license. Every source file has been modified.