Repository files navigation

See the presentation here

Petclinic is aSpring Boot application built usingMaven. You can build a jar file and run it from the command line:

git clone https://github.com/spring-projects/spring-petclinic.gitcd spring-petclinic./mvnw packagejava -jar target/*.jar

You can then access petclinic here:http://localhost:8080/

Or you can run it from Maven directly using the Spring Boot Maven plugin. If you do this it will pick up changes that you make in the project immediately (changes to Java source files require a compile as well - most people use an IDE for this):

./mvnw spring-boot:run

Our issue tracker is available here:https://github.com/spring-projects/spring-petclinic/issues

In its default configuration, Petclinic uses an in-memory database (H2) whichgets populated at startup with data. The h2 console is automatically exposed athttp://localhost:8080/h2-consoleand it is possible to inspect the content of the database using thejdbc:h2:mem:testdb url.

A similar setup is provided for MySql in case a persistent database configuration is needed. Note that whenever the database type is changed, the app needs to be run with a different profile:spring.profiles.active=mysql for MySql.

You could start MySql locally with whatever installer works for your OS, or with docker:

docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:5.7.8

Further documentation is providedhere.

The following items should be installed in your system:

• Java 8 or newer.
• git command line tool (https://help.github.com/articles/set-up-git)
• Your preferred IDE
  • Eclipse with the m2e plugin. Note: when m2e is available, there is an m2 icon inHelp -> About dialog. If m2e isnot there, just follow the install process here:https://www.eclipse.org/m2e/
  • Spring Tools Suite (STS)
  • IntelliJ IDEA
  • VS Code

1. On the command line

   git clone https://github.com/spring-projects/spring-petclinic.git

2. Inside Eclipse or STS

   File -> Import -> Maven -> Existing Maven project

   Then either build on the command line./mvnw generate-resources or using the Eclipse launcher (right click on project andRun As -> Maven install) to generate the css. Run the application main method by right clicking on it and choosingRun As -> Java Application.

3. Inside IntelliJ IDEAIn the main menu, choose File -> Open and select the Petclinicpom.xml. Click on theOpen button.

   CSS files are generated from the Maven build. You can either build them on the command line./mvnw generate-resources or right click on thespring-petclinic project thenMaven -> Generates sources and Update Folders.

   A run configuration namedPetClinicApplication should have been created for you if you're using a recent Ultimate version. Otherwise, run the application by right clicking on thePetClinicApplication main class and choosingRun 'PetClinicApplication'.

4. Navigate to Petclinic

   Visithttp://localhost:8080 in your browser.

The Spring Petclinic "main" branch in thespring-projectsGitHub org is the "canonical" implementation, currently based on Spring Boot and Thymeleaf. There arequite a few forks in a special GitHub orgspring-petclinic. If you have a special interest in a different technology stackthat could be used to implement the Pet Clinic then please join the community there.

One of the best parts about working on the Spring Petclinic application is that we have the opportunity to work in direct contact with many Open Source projects. We found some bugs/suggested improvements on various topics such as Spring, Spring Data, Bean Validation and even Eclipse! In many cases, they've been fixed/implemented in just a few days.Here is a list of them:

Theissue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

For pull requests, editor preferences are available in theeditor config for easy use in common text editors. Read more and download plugins athttps://editorconfig.org. If you have not previously done so, please fill out and submit theContributor License Agreement.

The Spring PetClinic sample application is released under version 2.0 of theApache License.