git clone https://github.com/stagemonitor/spring-petclinic.git
cd spring-petclinic
# optional: spin up the stagemonitor backend and dashboards. Requires docker and docker-compose
# follow the easy steps described here: https://github.com/stagemonitor/stagemonitor-docker-compose
./mvnw spring-boot:run
You can then access petclinic here: http://localhost:8080/
We're using force push (git push -f) when updating the stagemonitor version for example to have a clean commit history
which reflects the steps of the installation guide. That's why you have to update petclinic this way:
git fetch
git reset --hard origin/master
Our issue tracker is available here: https://github.com/spring-projects/spring-petclinic/issues
In its default configuration, Petclinic uses an in-memory database (HSQLDB) which gets populated at startup with data. A similar setup is provided for MySql in case a persistent database configuration is needed. Note that whenever the database type is changed, the data-access.properties file needs to be updated and the mysql-connector-java artifact from the pom.xml needs to be uncommented.
You could start a MySql database with docker:
docker run -e MYSQL_ROOT_PASSWORD=petclinic -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:5.7.8
The following items should be installed in your system:
- Maven 3 (http://www.sonatype.com/books/mvnref-book/reference/installation.html)
- git command line tool (https://help.github.com/articles/set-up-git)
- Eclipse with the m2e plugin (m2e is installed by default when using the STS (http://www.springsource.org/sts) distribution of Eclipse)
Note: when m2e is available, there is an m2 icon in Help -> About dialog. If m2e is not there, just follow the install process here: http://eclipse.org/m2e/download/
- In the command line
git clone https://github.com/spring-projects/spring-petclinic.git
- Inside Eclipse
File -> Import -> Maven -> Existing Maven project
| Spring Boot Configuration | Class or Java property files |
|---|---|
| The Main Class | PetClinicApplication |
| Properties Files | application.properties |
| Caching | CacheConfig |
The Spring Petclinic master branch in the main spring-projects GitHub org is the "canonical" implementation, currently based on Spring Boot and Thymeleaf. There are quite a few forks in a special GitHub org spring-petclinic. If you have a special interest in a different technology stack that could be used to implement the Pet Clinic then please join the community there.
| Link | Main technologies |
|---|---|
| spring-framework-petclinic | Spring Framework XML configuration, JSP pages, 3 persistence layers: JDBC, JPA and Spring Data JPA |
| javaconfig branch | Same frameworks as the spring-framework-petclinic but with Java Configuration instead of XML |
| spring-petclinic-angular | AngularJS 1.x, Spring Boot and Spring Data JPA |
| spring-petclinic-microservices | Distributed version of Spring Petclinic built with Spring Cloud |
| spring-petclinic-reactjs | ReactJS (with TypeScript) and Spring Boot |
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:
| Name | Issue |
|---|---|
| Spring JDBC: simplify usage of NamedParameterJdbcTemplate | SPR-10256 and SPR-10257 |
| Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility | HV-790 and HV-792 |
| Spring Data: provide more flexibility when working with JPQL queries | DATAJPA-292 |
The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.
For pull requests, editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.